| blob | 36ac34b511ef739f2a87c3b37dc0cced790d11fd |
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:
39 "*Idle time delay before updating various things on the screen.
40 Various Emacs features that update auxiliary information when point moves
41 wait this many seconds after Emacs becomes idle before doing an update."
47 "Killing and yanking commands."
51 "Highlight (un)matching of parens and expressions."
57 "Switch to the next buffer in cyclic order."
64 "Switch to the previous buffer in cyclic order."
67 found)
75 \f
76 ;;; next-error support framework
79 "next-error support framework."
85 "Face used to highlight next error locus."
90 "*Highlighting of locations in selected source buffers.
91 If number, highlight the locus in next-error face for given time in seconds.
92 If t, use persistent overlays fontified in next-error face.
93 If nil, don't highlight the locus in the source buffer.
94 If `fringe-arrow', indicate the locus by the fringe arrow."
103 "*Highlighting of locations in non-selected source buffers.
104 If number, highlight the locus in next-error face for given time in seconds.
105 If t, use persistent overlays fontified in next-error face.
106 If nil, don't highlight the locus in the source buffer.
107 If `fringe-arrow', indicate the locus by the fringe arrow."
118 "The most recent next-error buffer.
119 A buffer becomes most recent when its compilation, grep, or
124 "Function to use to find the next error in the current buffer.
125 The function is called with 2 parameters:
126 ARG is an integer specifying by how many errors to move.
127 RESET is a boolean which, if non-nil, says to go back to the beginning
128 of the errors before moving.
129 Major modes providing compile-like functionality should set this variable
130 to indicate to `next-error' that this is a candidate buffer and how
136 &optional avoid-current
137 extra-test-inclusive
138 extra-test-exclusive)
139 "Test if BUFFER is a next-error capable buffer.
141 If AVOID-CURRENT is non-nil, treat the current buffer
142 as an absolute last resort only.
144 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
145 that normally would not qualify. If it returns t, the buffer
146 in question is treated as usable.
148 The function EXTRA-TEST-EXCLUSIVE, if non-nil is called in each buffer
149 that would normally be considered usable. if it returns nil,
150 that buffer is rejected."
155 ;; Optionally reject some buffers.
158 t)
159 ;; Optionally accept some other buffers.
164 extra-test-inclusive
165 extra-test-exclusive)
166 "Return a next-error capable buffer.
167 If AVOID-CURRENT is non-nil, treat the current buffer
168 as an absolute last resort only.
170 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffers
171 that normally would not qualify. If it returns t, the buffer
172 in question is treated as usable.
174 The function EXTRA-TEST-EXCLUSIVE, if non-nil is called in each buffer
175 that would normally be considered usable. If it returns nil,
176 that buffer is rejected."
178 ;; 1. If one window on the selected frame displays such buffer, return it.
184 avoid-current
185 extra-test-inclusive extra-test-exclusive)
190 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
193 extra-test-inclusive extra-test-exclusive))
194 next-error-last-buffer)
195 ;; 3. If the current buffer is acceptable, choose it.
197 extra-test-inclusive extra-test-exclusive)
199 ;; 4. Look for any acceptable buffer.
204 extra-test-inclusive extra-test-exclusive)))
207 ;; 5. Use the current buffer as a last resort if it qualifies,
208 ;; even despite AVOID-CURRENT.
211 extra-test-inclusive extra-test-exclusive)
215 ;; 6. Give up.
219 "Visit next next-error message and corresponding source code.
221 If all the error messages parsed so far have been processed already,
222 the message buffer is checked for new ones.
224 A prefix ARG specifies how many error messages to move;
225 negative means move back to previous error messages.
227 and start at the first error.
229 The RESET argument specifies that we should restart from the beginning.
232 compilation, grep, or occur buffer. It can also operate on any
234 more generally, on any buffer in Compilation mode or with
235 Compilation Minor mode enabled, or any buffer in which
236 `next-error-function' is bound to an appropriate function.
237 To specify use of a particular buffer for error messages, type
239 in the current frame.
242 it stays with that buffer until you use it in some other buffer which
243 uses Compilation mode or Compilation Minor mode.
245 See variables `compilation-parse-errors-function' and
246 \`compilation-error-regexp-alist' for customization ideas."
250 ;; we know here that next-error-function is a valid symbol we can funcall
260 "Visit previous next-error message and corresponding source code.
262 Prefix arg N says how many error messages to move backwards (or
263 forwards, if negative).
270 "Restart at the first error.
271 Visit corresponding source code.
272 With prefix arg N, visit the source code of the Nth error.
278 "Move point to the next error in the next-error buffer and highlight match.
279 Prefix arg N says how many error messages to move forwards (or
280 backwards, if negative).
282 select the source buffer."
289 "Move point to the previous error in the next-error buffer and highlight match.
290 Prefix arg N says how many error messages to move backwards (or
291 forwards, if negative).
293 select the source buffer."
297 ;;; Internal variable for `next-error-follow-mode-post-command-hook'.
301 "Minor mode for compilation, occur and diff modes.
302 When turned on, cursor motion in the compilation, grep, occur or diff
303 buffer causes automatic display of the corresponding source code
304 location."
311 ;;; Used as a `post-command-hook' by `next-error-follow-mode'
312 ;;; for the *Compilation* *grep* and *Occur* buffers.
322 \f
323 ;;;
326 "Major mode not specialized for anything in particular.
327 Other major modes are defined by comparison with this one."
332 ;; Making and deleting lines.
335 "Insert a newline, and move to left margin of the new line if it's blank.
336 If `use-hard-newlines' is non-nil, the newline is marked with the
337 text-property `hard'.
338 With ARG, insert that many newlines.
339 Call `auto-fill-function' if the current column number is greater
340 than the value of `fill-column' and ARG is nil."
343 ;; Inserting a newline at the end of a line produces better redisplay in
344 ;; try_window_id than inserting at the beginning of a line, and the textual
345 ;; result is the same. So, if we're at beginning of line, pretend to be at
346 ;; the end of the previous line.
349 ;; Make sure no functions want to be told about
350 ;; the range of the changes.
353 ;; Make sure there are no markers here.
356 ;; Make sure no text properties want to know
357 ;; where the change was.
362 ;; Make sure the newline before point isn't intangible.
364 ;; Make sure the newline before point isn't read-only.
366 ;; Make sure the newline before point isn't invisible.
368 ;; Make sure the newline before point has the same
369 ;; properties as the char before it (if any).
376 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
377 ;; Set last-command-char to tell self-insert what to insert.
379 ;; Don't auto-fill if we have a numeric argument.
380 ;; Also not if flag is true (it would fill wrong line);
381 ;; there is no need to since we're at BOL.
385 ;; If we get an error in self-insert-command, put point at right place.
387 ;; Even if we did *not* get an error, keep that forward-char;
388 ;; all further processing should apply to the newline that the user
389 ;; thinks he inserted.
391 ;; Mark the newline(s) `hard'.
395 ;; If the newline leaves the previous line blank,
396 ;; and we have a left margin, delete that from the blank line.
404 ;; Indent the line after the newline, except in one case:
405 ;; when we added the newline at the beginning of a line
406 ;; which starts a page.
409 nil)
414 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
420 "Insert a newline and leave point before it.
421 If there is a fill prefix and/or a left-margin, insert them on the new line
422 if the line would have been blank.
423 With arg N, insert N newlines."
428 ;; Don't expand an abbrev before point.
442 "Split current line, moving portion beyond point vertically down.
443 If the current line starts with `fill-prefix', insert it on the new
444 line as well. With prefix ARG, don't insert fill-prefix on new line.
446 When called from Lisp code, ARG may be a prefix string to copy."
451 ;; What prefix should we check for (nil means don't).
455 ;; Does this line start with it?
466 "Join this line to previous and fix up whitespace at join.
467 If there is a fill prefix, delete it from the beginning of this line.
468 With argument, join this line to following line."
475 ;; If the second line started with the fill prefix,
476 ;; delete the prefix.
488 "On blank line, delete all surrounding blank lines, leaving just one.
489 On isolated blank line, delete that one.
490 On nonblank line, delete any immediately following blank lines."
496 ;; Set singleblank if there is just one blank line here.
503 ;; Delete preceding blank lines, and this one too if it's the only one.
512 ;; Delete following blank lines, unless the current line is blank
513 ;; and there are no following blank lines.
522 ;; Handle the special case where point is followed by newline and eob.
523 ;; Delete the line, leaving point at eob.
528 "Delete all the trailing whitespace across the current buffer.
529 All whitespace after the last non-whitespace character in a line is deleted.
531 A formfeed is not considered whitespace by this function."
538 ;; Don't delete formfeeds, even if they are considered whitespace.
545 "Insert a newline, then indent according to major mode.
546 Indentation is done using the value of `indent-line-function'.
547 In programming language modes, this is the same as TAB.
548 In some text modes, where TAB inserts a tab, this command indents to the
549 column specified by the function `current-left-margin'."
556 "Reindent current line, insert newline, then indent the new line.
557 Indentation of both lines is done according to the current major mode,
558 which means calling the current value of `indent-line-function'.
559 In programming language modes, this is the same as TAB.
560 In some text modes, where TAB inserts a tab, this indents to the
561 column specified by the function `current-left-margin'."
564 ;; Be careful to insert the newline before indenting the line.
565 ;; Otherwise, the indentation might be wrong.
574 "Read next input character and insert it.
575 This is useful for inserting control characters.
577 If the first character you type after this command is an octal digit,
578 you should type a sequence of octal digits which specify a character code.
579 Any nondigit terminates the sequence. If the terminator is a RET,
580 it is discarded; any other terminator is used itself as input.
581 The variable `read-quoted-char-radix' specifies the radix for this feature;
582 set it to 10 or 16 to use decimal or hex instead of octal.
584 In overwrite mode, this function inserts the character anyway, and
585 does not handle octal digits specially. This means that if you use
586 overwrite as your normal editing mode, you can use this function to
587 insert characters when necessary.
589 In binary overwrite mode, this function does overwrite, and octal
590 digits are interpreted as a character code. This is intended to be
591 useful for editing binary files."
598 ;; Assume character codes 0240 - 0377 stand for characters in some
599 ;; single-byte character set, and convert them to Emacs
600 ;; characters.
613 "Move forward ARG lines and position at first nonblank character."
619 "Move backward ARG lines and position at first nonblank character."
625 "Move point to the first non-whitespace character on this line."
629 ;; Move back over chars that have whitespace syntax but have the p flag.
633 "Fixup white space between objects around point.
634 Leave one space or none, according to the context."
641 nil
645 "Delete all spaces and tabs around point.
646 If BACKWARD-ONLY is non-nil, only delete spaces before point."
651 orig-pos
660 "Delete all spaces and tabs around point, leaving one space (or N spaces)."
674 \f
676 "Move point to the beginning of the buffer; leave mark at previous position.
678 With numeric arg N, put point N/10 of the way from the beginning.
680 If the buffer is narrowed, this command uses the beginning and size
681 of the accessible part of the buffer.
683 Don't use this command in Lisp programs!
684 \(goto-char (point-min)) is faster and avoids clobbering the mark."
693 ;; Avoid overflow for large buffer sizes!
701 "Move point to the end of the buffer; leave mark at previous position.
703 With numeric arg N, put point N/10 of the way from the end.
705 If the buffer is narrowed, this command uses the beginning and size
706 of the accessible part of the buffer.
708 Don't use this command in Lisp programs!
709 \(goto-char (point-max)) is faster and avoids clobbering the mark."
718 ;; Avoid overflow for large buffer sizes!
723 ;; If we went to a place in the middle of the buffer,
724 ;; adjust it to the beginning of a line.
727 ;; If the end of the buffer is not already on the screen,
728 ;; then scroll specially to put it near, but not at, the bottom.
733 "Put point at beginning and mark at end of buffer.
734 You probably should not use this function in Lisp programs;
735 it is usually a mistake for a Lisp function to use any subroutine
736 that uses or sets the mark."
741 \f
743 ;; Counting lines, one way or another.
746 "Goto line ARG, counting from line 1 at beginning of buffer.
747 Normally, move point in the current buffer.
749 displayed other buffer, and switch to it. When called from Lisp code,
750 the optional argument BUFFER specifies a buffer to switch to.
752 If there's a number in the buffer at point, it is the default for ARG."
756 ;; Look for a default, a number in the buffer at point.
765 ;; Decide if we're switching buffers.
773 ;; Read the argument, offering that number (if any) as default.
776 buffer-prompt
777 default)
778 nil nil t
779 'minibuffer-history
780 default)
781 buffer))))
782 ;; Switch to the desired buffer, one way or another.
787 ;; Move to the specified line number in that buffer.
796 "Print number of lines and characters in the region."
802 "Print the current buffer line number and narrowed line number of point."
815 "Return number of lines between START and END.
816 This is usually the number of newlines between them,
817 but can be one more if START is not equal to END
818 and the greater of them is not at the start of a line."
834 done)))
838 "Return (narrowed) buffer line number at position POS.
839 If POS is nil, use current buffer location."
849 "Print info on cursor position (on screen and within buffer).
850 Also describe the character after point, and give its character code
851 in octal, decimal and hex.
853 For a non-ASCII multibyte character, also give its encoding in the
854 buffer's selected coding system if the coding system encodes the
855 character safely. If the character is encoded into one byte, that
856 code is shown in hex. If the character is encoded into more than one
859 In addition, with prefix argument, show details about that character
860 in *Help* buffer. See also the command `describe-char'."
868 ;; Avoid overflow from multiplying by 100!
872 ""
878 pos total percent beg end col hscroll)
880 pos total percent col hscroll))
882 encoded encoding-msg)
893 char char char
895 "..."
899 ;; We show the detailed information about CHAR.
906 encoding-msg pos total percent beg end col hscroll)
911 encoding-msg pos total percent col hscroll))))))
912 \f
917 m)
923 "*Value to use for `print-level' when printing value in `eval-expression'.
924 A value of nil means no limit."
930 "*Value to use for `print-length' when printing value in `eval-expression'.
931 A value of nil means no limit."
937 "*Non-nil means set `debug-on-error' when evaluating in `eval-expression'.
938 If nil, don't change the value of `debug-on-error'."
944 "Format VALUE as a result of evaluated expression.
945 Return a formatted string which is displayed in the echo area
946 in addition to the value printed by prin1 in functions which
947 display the result of expression evaluation."
960 ;; We define this, rather than making `eval' interactive,
961 ;; for the sake of completion of names like eval-region, eval-current-buffer.
964 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
965 Value is also consed on to front of the variable `values'.
966 Optional argument EVAL-EXPRESSION-INSERT-VALUE, if non-nil, means
967 insert the result into the current buffer instead of printing it in
968 the echo area."
971 nil read-expression-map t
973 current-prefix-arg))
978 ;; Bind debug-on-error to something unique so that we can
979 ;; detect when evaled code changes it.
983 ;; If evaled code has changed the value of debug-on-error,
984 ;; propagate that change to the global binding.
1000 "Prompting with PROMPT, let user edit COMMAND and eval result.
1001 COMMAND is a Lisp expression. Let user edit that expression in
1002 the minibuffer, then read and evaluate the result."
1009 read-expression-map t
1011 ;; If command was added to command-history as a string,
1012 ;; get rid of that. We want only evaluable expressions there.
1016 ;; If command to be redone does not match front of history,
1017 ;; add it to the history.
1023 "Edit and re-evaluate last complex command, or ARGth from last.
1024 A complex command is one which used the minibuffer.
1025 The command is placed in the minibuffer as a Lisp form for editing.
1026 The result is executed, repeating the command as changed.
1027 If the command has been changed or is not the most recent previous command
1028 it is added to the front of the command history.
1029 You can use the minibuffer history commands \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
1030 to get different commands to edit and resubmit."
1033 newcmd)
1045 ;; If command was added to command-history as a
1046 ;; string, get rid of that. We want only
1047 ;; evaluable expressions there.
1051 ;; If command to be redone does not match front of history,
1052 ;; add it to the history.
1059 \f
1061 "Default minibuffer history list.
1062 This is used for all minibuffer input
1065 "Control whether history list elements are expressions or strings.
1066 If the value of this variable equals current minibuffer depth,
1067 they are expressions; otherwise they are strings.
1068 \(That convention is designed to do the right thing fora
1075 "Text that was in this minibuffer before any history commands.
1076 This is nil if there have not yet been any history commands
1085 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1089 "*Minibuffer history variables for which matching should ignore case.
1090 If a history variable is a member of this list, then the
1092 commands ignore case when searching it, regardless of `case-fold-search'."
1097 "Find the previous history element that matches REGEXP.
1098 \(Previous history elements refer to earlier actions.)
1099 With prefix argument N, search for Nth previous match.
1100 If N is negative, find the next or Nth next match.
1101 Normally, history elements are matched case-insensitively if
1102 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1103 makes the search case-sensitive.
1104 See also `minibuffer-history-case-insensitive-variables'."
1108 nil
1109 minibuffer-local-map
1110 nil
1111 'minibuffer-history-search-history
1113 ;; Use the last regexp specified, by default, if input is empty.
1118 regexp)
1128 ;; On some systems, ignore case for file names.
1130 minibuffer-history-case-insensitive-variables)
1131 t
1132 ;; Respect the user's setting for case-fold-search:
1133 case-fold-search)
1134 nil))
1135 prevpos
1136 match-string
1137 match-offset
1144 "No later matching history item"
1165 next-matching-history-element))
1169 "Find the next history element that matches REGEXP.
1170 \(The next history element refers to a more recent action.)
1171 With prefix argument N, search for Nth next match.
1172 If N is negative, find the previous or Nth previous match.
1173 Normally, history elements are matched case-insensitively if
1174 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1175 makes the search case-sensitive."
1179 nil
1180 minibuffer-local-map
1181 nil
1182 'minibuffer-history-search-history
1184 ;; Use the last regexp specified, by default, if input is empty.
1189 regexp)
1196 "Insert the next element of the minibuffer history into the minibuffer."
1201 elt minibuffer-returned-to-present)
1213 previous-history-element))
1235 elt))
1239 "Inserts the previous element of the minibuffer history into the minibuffer."
1244 "Get next history element which completes the minibuffer before the point.
1245 The contents of the minibuffer after the point are deleted, and replaced
1246 by the new completion."
1252 n)
1253 ;; next-matching-history-element always puts us at (point-min).
1254 ;; Move to the position we were at before changing the buffer contents.
1255 ;; This is still sensical, because the text before point has not changed.
1259 "\
1260 Get previous history element which completes the minibuffer before the point.
1261 The contents of the minibuffer after the point are deleted, and replaced
1262 by the new completion."
1266 ;; For compatibility with the old subr of the same name.
1268 "Return the display width of the minibuffer prompt.
1269 Return 0 if current buffer is not a mini-buffer."
1270 ;; Return the width of everything before the field at the end of
1271 ;; the buffer; this should be 0 for normal buffers.
1273 \f
1274 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1287 "Within a run of consecutive undo commands, list remaining to be undone.
1291 "Undo some previous changes.
1292 Repeat this command to undo more changes.
1293 A numeric argument serves as a repeat count.
1295 In Transient Mark mode when the mark is active, only undo changes within
1297 as an argument limits undo to changes within the current region."
1299 ;; Make last-command indicate for the next command that this was an undo.
1300 ;; That way, another undo will undo more.
1301 ;; If we get to the end of the undo history and get an error,
1302 ;; another undo command will find the undo history empty
1303 ;; and will get another error. To begin undoing the undos,
1304 ;; you must type some other command.
1307 ;; If we get an error in undo-start,
1308 ;; the next command should not be a "consecutive undo".
1309 ;; So set `this-command' to something other than `undo'.
1314 ;; If something (a timer or filter?) changed the buffer
1315 ;; since the previous command, don't continue the undo seq.
1319 ;; If the last undo record made was made by undo
1320 ;; it shows nothing else happened in between.
1327 ;; get rid of initial undo boundary
1329 ;; If we got this far, the next command should be a consecutive undo.
1331 ;; Check to see whether we're hitting a redo record, and if
1332 ;; so, ask the user whether she wants to skip the redo/undo pair.
1339 ;; The equiv entry might point to another redo record if we have done
1340 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1348 ;; Record the fact that the just-generated undo records come from an
1349 ;; undo operation, so we can skip them later on.
1350 ;; I don't know how to do that in the undo-in-region case.
1353 ;; Don't specify a position in the undo record for the undo command.
1354 ;; Instead, undoing this should move point to where the change is.
1373 ;; Record what the current undo list says,
1374 ;; so the next command can tell if the buffer was modified in between.
1379 "Make BUFFER stop keeping undo information.
1380 No argument or nil as argument means do this for the current buffer."
1386 "Undo some previous changes.
1387 Repeat this command to undo more changes.
1388 A numeric argument serves as a repeat count.
1389 Contrary to `undo', this will not redo a previous undo."
1392 ;; Richard said that we should not use C-x <uppercase letter> and I have
1393 ;; no idea whereas to bind it. Any suggestion welcome. -stef
1394 ;; (define-key ctl-x-map "U" 'undo-only)
1397 "Non-nil while performing an undo.
1401 "Undo back N undo-boundaries beyond what was already undone recently.
1402 Call `undo-start' to get ready to undo recent changes,
1403 then call `undo-more' one or more times to undo them."
1413 ;; Deep copy of a list
1415 "Make a copy of undo list LIST."
1421 elt))
1424 "Set `pending-undo-list' to the front of the undo list.
1425 The next call to `undo-more' will undo the most recently made change.
1426 If BEG and END are specified, then only undo elements
1427 that apply to text between BEG and END are used; other undo elements
1428 are ignored. If BEG and END are nil, all undo elements are used."
1434 buffer-undo-list)))
1439 "Return a list of undo elements for the region START to END.
1440 The elements come from `buffer-undo-list', but we keep only
1441 the elements inside this region, and discard those outside this region.
1442 If we find an element that crosses an edge of this region,
1443 we stop and ignore all further elements."
1446 undo-adjusted-markers
1447 some-rejected
1448 undo-elt undo-elt temp-undo-list delta)
1453 ;; This is a "was unmodified" element.
1454 ;; Keep it if we have kept everything thus far.
1461 ;; Don't put two nils together in the list
1475 ;; Loop down the earlier events adjusting their buffer
1476 ;; positions to reflect the fact that a change to the buffer
1477 ;; isn't being undone. We only need to process those element
1478 ;; types which undo-elt-in-region will return as being in
1479 ;; the region since only those types can ever get into the
1480 ;; output
1489 ;; (TEXT . POSITION)
1496 ;; (BEGIN . END)
1501 ;; (nil PROPERTY VALUE BEG . END)
1511 "Determine whether UNDO-ELT falls inside the region START ... END.
1512 If it crosses the edge, we return nil."
1517 t)
1519 nil)
1521 ;; (TEXT . POSITION)
1525 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1526 ;; See if MARKER is inside the region.
1537 ;; (nil PROPERTY VALUE BEG . END)
1542 ;; (BEGIN . END)
1547 "Test whether UNDO-ELT crosses one edge of that region START ... END.
1548 This assumes we have already decided that UNDO-ELT
1549 is not *inside* the region START...END."
1552 ;; (nil PROPERTY VALUE BEG . END)
1557 ;; (BEGIN . END)
1561 ;; Return the first affected buffer position and the delta for an undo element
1562 ;; delta is defined as the change in subsequent buffer positions if we *did*
1563 ;; the undo.
1567 ;; (TEXT . POSITION)
1570 ;; (BEGIN . END)
1577 "If non-nil ask about discarding undo info for the current command.
1578 Normally, Emacs discards the undo info for the current command if
1579 it exceeds `undo-outer-limit'. But if you set this option
1580 non-nil, it asks in the echo area whether to discard the info.
1581 If you answer no, there a slight risk that Emacs might crash, so
1582 only do it if you really want to undo the command.
1584 This option is mainly intended for debugging. You have to be
1585 careful if you use it for other purposes. Garbage collection is
1586 inhibited while the question is asked, meaning that Emacs might
1587 leak memory. So you should make sure that you do not wait
1588 excessively long before answering the question."
1594 "If non-nil, an extra level of size that's ok in an undo item.
1595 We don't ask the user about truncating the undo list until the
1596 current item gets bigger than this amount.
1601 ;; When the first undo batch in an undo list is longer than
1602 ;; undo-outer-limit, this function gets called to warn the user that
1603 ;; the undo info for the current command was discarded. Garbage
1604 ;; collection is inhibited around the call, so it had better not do a
1605 ;; lot of consing.
1611 ;; Don't ask the question again unless it gets even bigger.
1612 ;; This applies, in particular, if the user quits from the question.
1613 ;; Such a quit quits out of GC, but something else will call GC
1614 ;; again momentarily. It will call this function again,
1615 ;; but we don't want to ask the question again.
1622 t)
1623 nil))
1628 "The undo info was discarded because it exceeded \
1629 `undo-outer-limit'.
1631 This is normal if you executed a command that made a huge change
1632 to the buffer. In that case, to prevent similar problems in the
1633 future, set `undo-outer-limit' to a value that is large enough to
1634 cover the maximum size of normal changes you expect a single
1635 command to make, but not so large that it might exceed the
1636 maximum memory allotted to Emacs.
1638 If you did not execute any such command, the situation is
1639 probably due to a bug and you should report it.
1641 You can disable the popping up of this buffer by adding the entry
1645 t))
1646 \f
1654 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
1655 This buffer is used when `shell-command' or `shell-command-on-region'
1656 is run interactively. A value of nil means that output to stderr and
1660 "Execute string COMMAND in inferior shell; display output, if any.
1661 With prefix argument, insert the COMMAND's output at point.
1663 If COMMAND ends in ampersand, execute it asynchronously.
1664 The output appears in the buffer `*Async Shell Command*'.
1665 That buffer is in shell mode.
1667 Otherwise, COMMAND is executed synchronously. The output appears in
1668 the buffer `*Shell Command Output*'. If the output is short enough to
1669 display in the echo area (which is determined by the variables
1670 `resize-mini-windows' and `max-mini-window-height'), it is shown
1671 there, but it is nonetheless available in buffer `*Shell Command
1672 Output*' even though that buffer is not automatically displayed.
1674 To specify a coding system for converting non-ASCII characters
1676 before this command.
1678 Noninteractive callers can specify coding systems by binding
1679 `coding-system-for-read' and `coding-system-for-write'.
1681 The optional second argument OUTPUT-BUFFER, if non-nil,
1682 says to put the output in some other buffer.
1683 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1684 If OUTPUT-BUFFER is not a buffer and not nil,
1685 insert output in current buffer. (This cannot be done asynchronously.)
1686 In either case, the output is inserted after point (leaving mark after it).
1688 If the command terminates without error, but generates output,
1690 the output can be displayed in the echo area or in its buffer.
1691 If the output is short enough to display in the echo area
1692 \(determined by the variable `max-mini-window-height' if
1693 `resize-mini-windows' is non-nil), it is shown there. Otherwise,
1694 the buffer containing the output is displayed.
1698 of the output.
1700 If there is no output, or if output is inserted in the current buffer,
1701 then `*Shell Command Output*' is deleted.
1703 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
1704 or buffer name to which to direct the command's standard error output.
1705 If it is nil, error output is mingled with regular output.
1706 In an interactive call, the variable `shell-command-default-error-buffer'
1707 specifies the value of ERROR-BUFFER."
1711 current-prefix-arg
1712 shell-command-default-error-buffer))
1713 ;; Look for a handler in case default-directory is a remote file name.
1721 ;; Output goes in current buffer.
1727 temporary-file-directory)))
1728 nil)))
1731 ;; We do not use -f for csh; we will not support broken use of
1732 ;; .cshrcs. Even the BSD csh manual says to use
1733 ;; "if ($?prompt) exit" before things which are not useful
1734 ;; non-interactively. Besides, if someone wants their other
1735 ;; aliases for shell commands then they can still have them.
1739 t)
1740 nil shell-command-switch command)
1747 ;; Do no formatting while reading error file,
1748 ;; because that can run a shell command, and we
1749 ;; don't want that to cause an infinite recursion.
1751 ;; Put point after the inserted errors.
1755 ;; This is like exchange-point-and-mark, but doesn't
1756 ;; activate the mark. It is cleaner to avoid activation,
1757 ;; even though the command loop would deactivate the mark
1758 ;; because we inserted text.
1762 ;; Output goes in a separate buffer.
1763 ;; Preserve the match data in case called from a program.
1766 ;; Command ending with ampersand means asynchronous.
1770 proc)
1771 ;; Remove the ampersand.
1773 ;; If will kill a process, query first.
1785 shell-command-switch command))
1789 ))
1791 output-buffer nil error-buffer)))))))
1795 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
1796 MESSAGE may be either a string or a buffer.
1798 A buffer is displayed using `display-buffer' if MESSAGE is too long for
1799 the maximum height of the echo area, as defined by `max-mini-window-height'
1800 if `resize-mini-windows' is non-nil.
1802 Returns either the string shown in the echo area, or when a pop-up
1803 buffer is used, the window used to display it.
1805 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
1806 name of the buffer used to display it in the case where a pop-up buffer
1807 is used, defaulting to `*Message*'. In the case where MESSAGE is a
1808 string and it is displayed in the echo area, it is not specified whether
1809 the contents are inserted into the buffer anyway.
1811 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
1812 and only used if a buffer is displayed."
1814 ;; Trivial case where we can use the echo area
1818 ;; Trivial case where we can just remove single trailing newline
1821 ;; General case
1824 message
1833 0
1837 (<= lines
1841 max-mini-window-height))
1843 max-mini-window-height)
1847 ;; Don't use the echo area if the output buffer is
1848 ;; already dispayed in the selected frame.
1850 ;; Echo area
1856 ;; Buffer
1859 not-this-window frame))))))))
1862 ;; We have a sentinel to prevent insertion of a termination message
1863 ;; in the buffer itself.
1871 &optional output-buffer replace
1872 error-buffer display-error-buffer)
1873 "Execute string COMMAND in inferior shell with region as input.
1874 Normally display output (if any) in temp buffer `*Shell Command Output*';
1875 Prefix arg means replace the region with it. Return the exit code of
1876 COMMAND.
1878 To specify a coding system for converting non-ASCII characters
1880 before this command. By default, the input (from the current buffer)
1881 is encoded in the same coding system that will be used to save the file,
1882 `buffer-file-coding-system'. If the output is going to replace the region,
1883 then it is decoded from that same coding system.
1885 The noninteractive arguments are START, END, COMMAND,
1886 OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
1887 Noninteractive callers can specify coding systems by binding
1888 `coding-system-for-read' and `coding-system-for-write'.
1890 If the command generates output, the output may be displayed
1891 in the echo area or in a buffer.
1892 If the output is short enough to display in the echo area
1893 \(determined by the variable `max-mini-window-height' if
1894 `resize-mini-windows' is non-nil), it is shown there. Otherwise
1895 it is displayed in the buffer `*Shell Command Output*'. The output
1896 is available in that buffer in both cases.
1898 If there is output and an error, a message about the error
1899 appears at the end of the output.
1901 If there is no output, or if output is inserted in the current buffer,
1902 then `*Shell Command Output*' is deleted.
1904 If the optional fourth argument OUTPUT-BUFFER is non-nil,
1905 that says to put the output in some other buffer.
1906 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1907 If OUTPUT-BUFFER is not a buffer and not nil,
1908 insert output in the current buffer.
1909 In either case, the output is inserted after point (leaving mark after it).
1911 If REPLACE, the optional fifth argument, is non-nil, that means insert
1912 the output in place of text from START to END, putting point and mark
1913 around it.
1915 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
1916 or buffer name to which to direct the command's standard error output.
1917 If it is nil, error output is mingled with regular output.
1918 If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
1919 were any errors. (This is always t, interactively.)
1920 In an interactive call, the variable `shell-command-default-error-buffer'
1921 specifies the value of ERROR-BUFFER."
1925 ;; Do this before calling region-beginning
1926 ;; and region-end, in case subprocess output
1927 ;; relocates them while we are in the minibuffer.
1929 nil nil nil
1931 ;; call-interactively recognizes region-beginning and
1932 ;; region-end specially, leaving them in the history.
1934 string
1935 current-prefix-arg
1936 current-prefix-arg
1937 shell-command-default-error-buffer
1938 t)))
1944 temporary-file-directory)))
1945 nil))
1946 exit-status)
1950 ;; Replace specified region with output from command.
1952 ;; Don't muck with mark unless REPLACE says we should.
1959 t)
1960 nil shell-command-switch command))
1961 ;; It is rude to delete a buffer which the command is not using.
1962 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
1963 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
1964 ;; (kill-buffer shell-buffer)))
1965 ;; Don't muck with mark unless REPLACE says we should.
1967 ;; No prefix argument: put the output in a temp buffer,
1968 ;; replacing its entire contents.
1973 ;; If the input is the same buffer as the output,
1974 ;; delete everything but the specified region,
1975 ;; then replace that region with the output.
1981 shell-file-name t
1984 t)
1985 nil shell-command-switch
1986 command)))
1987 ;; Clear the output buffer, then run the command with
1988 ;; output there.
2000 buffer)
2001 nil shell-command-switch command)))
2002 ;; Report the output.
2012 ;; There's some output, display it
2014 ;; No output; error?
2018 "some error output"
2024 output))
2027 exit-status))
2030 exit-status output))))
2031 ;; Don't kill: there might be useful info in the undo-log.
2032 ;; (kill-buffer buffer)
2033 ))))
2041 ;; Do no formatting while reading error file,
2042 ;; because that can run a shell command, and we
2043 ;; don't want that to cause an infinite recursion.
2045 ;; Put point after the inserted errors.
2050 exit-status))
2053 "Execute shell command COMMAND and return its output as a string."
2056 standard-output
2060 "Process files synchronously in a separate process.
2061 Similar to `call-process', but may invoke a file handler based on
2062 `default-directory'. The current working directory of the
2063 subprocess is `default-directory'.
2065 File names in INFILE and BUFFER are handled normally, but file
2066 names in ARGS should be relative to `default-directory', as they
2067 are passed to the process verbatim. \(This is a difference to
2068 `call-process' which does not support file handlers for INFILE
2069 and BUFFER.\)
2071 Some file handlers might not support all variants, for example
2072 they might behave as if DISPLAY was nil, regardless of the actual
2073 value passed."
2075 lc stderr-file)
2085 display args)
2091 \f
2095 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
2096 (define-key map [switch-frame] nil)
2097 (define-key map [?\C-u] 'universal-argument-more)
2098 (define-key map [?-] 'universal-argument-minus)
2099 (define-key map [?0] 'digit-argument)
2100 (define-key map [?1] 'digit-argument)
2101 (define-key map [?2] 'digit-argument)
2102 (define-key map [?3] 'digit-argument)
2103 (define-key map [?4] 'digit-argument)
2104 (define-key map [?5] 'digit-argument)
2105 (define-key map [?6] 'digit-argument)
2106 (define-key map [?7] 'digit-argument)
2107 (define-key map [?8] 'digit-argument)
2108 (define-key map [?9] 'digit-argument)
2109 (define-key map [kp-0] 'digit-argument)
2110 (define-key map [kp-1] 'digit-argument)
2111 (define-key map [kp-2] 'digit-argument)
2112 (define-key map [kp-3] 'digit-argument)
2113 (define-key map [kp-4] 'digit-argument)
2114 (define-key map [kp-5] 'digit-argument)
2115 (define-key map [kp-6] 'digit-argument)
2116 (define-key map [kp-7] 'digit-argument)
2117 (define-key map [kp-8] 'digit-argument)
2118 (define-key map [kp-9] 'digit-argument)
2119 (define-key map [kp-subtract] 'universal-argument-minus)
2120 map)
2123 (defvar universal-argument-num-events nil
2124 "Number of argument-specifying events read by `universal-argument'.
2125 `universal-argument-other-key' uses this to discard those events
2126 from (this-command-keys), and reread only the final command.")
2128 (defvar overriding-map-is-bound nil
2129 "Non-nil when `overriding-terminal-local-map' is `universal-argument-map'.")
2131 (defvar saved-overriding-map nil
2132 "The saved value of `overriding-terminal-local-map'.
2136 (defun ensure-overriding-map-is-bound ()
2137 "Check `overriding-terminal-local-map' is `universal-argument-map'."
2138 (unless overriding-map-is-bound
2139 (setq saved-overriding-map overriding-terminal-local-map)
2140 (setq overriding-terminal-local-map universal-argument-map)
2141 (setq overriding-map-is-bound t)))
2143 (defun restore-overriding-map ()
2144 "Restore `overriding-terminal-local-map' to its saved value."
2145 (setq overriding-terminal-local-map saved-overriding-map)
2146 (setq overriding-map-is-bound nil))
2148 (defun universal-argument ()
2149 "Begin a numeric argument for the following command.
2154 multiplies the argument by 4 each time.
2156 which is different in effect from any particular numeric argument.
2158 (interactive)
2159 (setq prefix-arg (list 4))
2160 (setq universal-argument-num-events (length (this-command-keys)))
2161 (ensure-overriding-map-is-bound))
2163 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
2164 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2165 (defun universal-argument-more (arg)
2166 (interactive "P")
2167 (if (consp arg)
2168 (setq prefix-arg (list (* 4 (car arg))))
2169 (if (eq arg '-)
2170 (setq prefix-arg (list -4))
2171 (setq prefix-arg arg)
2172 (restore-overriding-map)))
2173 (setq universal-argument-num-events (length (this-command-keys))))
2175 (defun negative-argument (arg)
2176 "Begin a negative numeric argument for the next command.
2178 (interactive "P")
2179 (cond ((integerp arg)
2180 (setq prefix-arg (- arg)))
2181 ((eq arg '-)
2182 (setq prefix-arg nil))
2183 (t
2184 (setq prefix-arg '-)))
2185 (setq universal-argument-num-events (length (this-command-keys)))
2186 (ensure-overriding-map-is-bound))
2188 (defun digit-argument (arg)
2189 "Part of the numeric argument for the next command.
2191 (interactive "P")
2192 (let* ((char (if (integerp last-command-char)
2193 last-command-char
2194 (get last-command-char 'ascii-character)))
2196 (cond ((integerp arg)
2197 (setq prefix-arg (+ (* arg 10)
2198 (if (< arg 0) (- digit) digit))))
2199 ((eq arg '-)
2200 ;; Treat -0 as just -, so that -01 will work.
2201 (setq prefix-arg (if (zerop digit) '- (- digit))))
2202 (t
2203 (setq prefix-arg digit))))
2204 (setq universal-argument-num-events (length (this-command-keys)))
2205 (ensure-overriding-map-is-bound))
2207 ;; For backward compatibility, minus with no modifiers is an ordinary
2208 ;; command if digits have already been entered.
2209 (defun universal-argument-minus (arg)
2210 (interactive "P")
2211 (if (integerp arg)
2212 (universal-argument-other-key arg)
2213 (negative-argument arg)))
2215 ;; Anything else terminates the argument and is left in the queue to be
2216 ;; executed as a command.
2217 (defun universal-argument-other-key (arg)
2218 (interactive "P")
2219 (setq prefix-arg arg)
2220 (let* ((key (this-command-keys))
2221 (keylist (listify-key-sequence key)))
2222 (setq unread-command-events
2223 (append (nthcdr universal-argument-num-events keylist)
2224 unread-command-events)))
2225 (reset-this-command-lengths)
2226 (restore-overriding-map))
2227 \f
2228 (defvar buffer-substring-filters nil
2229 "List of filter functions for `filter-buffer-substring'.
2230 Each function must accept a single argument, a string, and return
2231 a string. The buffer substring is passed to the first function
2232 in the list, and the return value of each function is passed to
2233 the next. The return value of the last function is used as the
2234 return value of `filter-buffer-substring'.
2236 If this variable is nil, no filtering is performed.")
2238 (defun filter-buffer-substring (beg end &optional delete)
2239 "Return the buffer substring between BEG and END, after filtering.
2240 The buffer substring is passed through each of the filter
2241 functions in `buffer-substring-filters', and the value from the
2242 last filter function is returned. If `buffer-substring-filters'
2243 is nil, the buffer substring is returned unaltered.
2245 If DELETE is non-nil, the text between BEG and END is deleted
2246 from the buffer.
2248 Point is temporarily set to BEG before caling
2249 `buffer-substring-filters', in case the functions need to know
2250 where the text came from.
2252 This function should be used instead of `buffer-substring' or
2253 `delete-and-extract-region' when you want to allow filtering to
2254 take place. For example, major or minor modes can use
2255 `buffer-substring-filters' to extract characters that are special
2256 to a buffer, and should not be copied into other buffers."
2257 (save-excursion
2258 (goto-char beg)
2259 (let ((string (if delete (delete-and-extract-region beg end)
2260 (buffer-substring beg end))))
2261 (dolist (filter buffer-substring-filters string)
2262 (setq string (funcall filter string))))))
2264 ;;;; Window system cut and paste hooks.
2266 (defvar interprogram-cut-function nil
2267 "Function to call to make a killed region available to other programs.
2269 Most window systems provide some sort of facility for cutting and
2270 pasting text between the windows of different programs.
2271 This variable holds a function that Emacs calls whenever text
2272 is put in the kill ring, to make the new kill available to other
2273 programs.
2275 The function takes one or two arguments.
2276 The first argument, TEXT, is a string containing
2277 the text which should be made available.
2278 The second, optional, argument PUSH, has the same meaning as the
2279 similar argument to `x-set-cut-buffer', which see.")
2281 (defvar interprogram-paste-function nil
2282 "Function to call to get text cut from other programs.
2284 Most window systems provide some sort of facility for cutting and
2285 pasting text between the windows of different programs.
2286 This variable holds a function that Emacs calls to obtain
2287 text that other programs have provided for pasting.
2289 The function should be called with no arguments. If the function
2290 returns nil, then no other program has provided such text, and the top
2291 of the Emacs kill ring should be used. If the function returns a
2292 string, then the caller of the function \(usually `current-kill')
2293 should put this string in the kill ring as the latest kill.
2295 Note that the function should return a string only if a program other
2296 than Emacs has provided a string for pasting; if Emacs provided the
2297 most recent string, the function should return nil. If it is
2298 difficult to tell whether Emacs or some other program provided the
2299 current string, it is probably good enough to return nil if the string
2300 is equal (according to `string=') to the last text Emacs provided.")
2301 \f
2304 ;;;; The kill ring data structure.
2306 (defvar kill-ring nil
2307 "List of killed text sequences.
2308 Since the kill ring is supposed to interact nicely with cut-and-paste
2309 facilities offered by window systems, use of this variable should
2310 interact nicely with `interprogram-cut-function' and
2311 `interprogram-paste-function'. The functions `kill-new',
2312 `kill-append', and `current-kill' are supposed to implement this
2313 interaction; you may want to use them instead of manipulating the kill
2314 ring directly.")
2316 (defcustom kill-ring-max 60
2317 "*Maximum length of kill ring before oldest elements are thrown away."
2318 :type 'integer
2319 :group 'killing)
2321 (defvar kill-ring-yank-pointer nil
2322 "The tail of the kill ring whose car is the last thing yanked.")
2324 (defun kill-new (string &optional replace yank-handler)
2325 "Make STRING the latest kill in the kill ring.
2326 Set `kill-ring-yank-pointer' to point to it.
2327 If `interprogram-cut-function' is non-nil, apply it to STRING.
2328 Optional second argument REPLACE non-nil means that STRING will replace
2329 the front of the kill ring, rather than being added to the list.
2331 Optional third arguments YANK-HANDLER controls how the STRING is later
2332 inserted into a buffer; see `insert-for-yank' for details.
2333 When a yank handler is specified, STRING must be non-empty (the yank
2334 handler, if non-nil, is stored as a `yank-handler' text property on STRING).
2336 When the yank handler has a non-nil PARAM element, the original STRING
2337 argument is not used by `insert-for-yank'. However, since Lisp code
2338 may access and use elements from the kill-ring directly, the STRING
2340 (if (> (length string) 0)
2341 (if yank-handler
2342 (put-text-property 0 (length string)
2343 'yank-handler yank-handler string))
2344 (if yank-handler
2345 (signal 'args-out-of-range
2346 (list string "yank-handler specified for empty string"))))
2347 (if (fboundp 'menu-bar-update-yank-menu)
2348 (menu-bar-update-yank-menu string (and replace (car kill-ring))))
2349 (if (and replace kill-ring)
2350 (setcar kill-ring string)
2351 (setq kill-ring (cons string kill-ring))
2352 (if (> (length kill-ring) kill-ring-max)
2353 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil)))
2354 (setq kill-ring-yank-pointer kill-ring)
2355 (if interprogram-cut-function
2356 (funcall interprogram-cut-function string (not replace))))
2358 (defun kill-append (string before-p &optional yank-handler)
2359 "Append STRING to the end of the latest kill in the kill ring.
2360 If BEFORE-P is non-nil, prepend STRING to the kill.
2361 Optional third argument YANK-HANDLER, if non-nil, specifies the
2362 yank-handler text property to be set on the combined kill ring
2363 string. If the specified yank-handler arg differs from the
2364 yank-handler property of the latest kill string, this function
2365 adds the combined string to the kill ring as a new element,
2366 instead of replacing the last kill with it.
2367 If `interprogram-cut-function' is set, pass the resulting kill to it."
2368 (let* ((cur (car kill-ring)))
2369 (kill-new (if before-p (concat string cur) (concat cur string))
2370 (or (= (length cur) 0)
2371 (equal yank-handler (get-text-property 0 'yank-handler cur)))
2372 yank-handler)))
2374 (defun current-kill (n &optional do-not-move)
2375 "Rotate the yanking point by N places, and then return that kill.
2376 If N is zero, `interprogram-paste-function' is set, and calling it
2377 returns a string, then that string is added to the front of the
2378 kill ring and returned as the latest kill.
2379 If optional arg DO-NOT-MOVE is non-nil, then don't actually move the
2380 yanking point; just return the Nth kill forward."
2381 (let ((interprogram-paste (and (= n 0)
2382 interprogram-paste-function
2383 (funcall interprogram-paste-function))))
2384 (if interprogram-paste
2385 (progn
2386 ;; Disable the interprogram cut function when we add the new
2387 ;; text to the kill ring, so Emacs doesn't try to own the
2388 ;; selection, with identical text.
2389 (let ((interprogram-cut-function nil))
2390 (kill-new interprogram-paste))
2391 interprogram-paste)
2392 (or kill-ring (error "Kill ring is empty"))
2393 (let ((ARGth-kill-element
2394 (nthcdr (mod (- n (length kill-ring-yank-pointer))
2395 (length kill-ring))
2396 kill-ring)))
2397 (or do-not-move
2398 (setq kill-ring-yank-pointer ARGth-kill-element))
2399 (car ARGth-kill-element)))))
2403 ;;;; Commands for manipulating the kill ring.
2405 (defcustom kill-read-only-ok nil
2406 "*Non-nil means don't signal an error for killing read-only text."
2407 :type 'boolean
2408 :group 'killing)
2410 (put 'text-read-only 'error-conditions
2411 '(text-read-only buffer-read-only error))
2412 (put 'text-read-only 'error-message "Text is read-only")
2414 (defun kill-region (beg end &optional yank-handler)
2415 "Kill between point and mark.
2416 The text is deleted but saved in the kill ring.
2420 If you want to append the killed region to the last killed text,
2423 If the buffer is read-only, Emacs will beep and refrain from deleting
2424 the text, but put the text in the kill ring anyway. This means that
2425 you can use the killing commands to copy text from a read-only buffer.
2427 This is the primitive for programs to kill text (as opposed to deleting it).
2428 Supply two arguments, character positions indicating the stretch of text
2429 to be killed.
2431 If the previous command was also a kill command,
2432 the text killed this time appends to the text killed last time
2433 to make one entry in the kill ring.
2435 In Lisp code, optional third arg YANK-HANDLER, if non-nil,
2436 specifies the yank-handler text property to be set on the killed
2437 text. See `insert-for-yank'."
2438 (interactive "r")
2439 (condition-case nil
2440 (let ((string (filter-buffer-substring beg end t)))
2441 (when string ;STRING is nil if BEG = END
2442 ;; Add that string to the kill ring, one way or another.
2443 (if (eq last-command 'kill-region)
2444 (kill-append string (< end beg) yank-handler)
2445 (kill-new string nil yank-handler)))
2446 (when (or string (eq last-command 'kill-region))
2447 (setq this-command 'kill-region))
2448 nil)
2449 ((buffer-read-only text-read-only)
2450 ;; The code above failed because the buffer, or some of the characters
2451 ;; in the region, are read-only.
2452 ;; We should beep, in case the user just isn't aware of this.
2453 ;; However, there's no harm in putting
2454 ;; the region's text in the kill ring, anyway.
2455 (copy-region-as-kill beg end)
2456 ;; Set this-command now, so it will be set even if we get an error.
2457 (setq this-command 'kill-region)
2458 ;; This should barf, if appropriate, and give us the correct error.
2459 (if kill-read-only-ok
2460 (progn (message "Read only text copied to kill ring") nil)
2461 ;; Signal an error if the buffer is read-only.
2462 (barf-if-buffer-read-only)
2463 ;; If the buffer isn't read-only, the text is.
2464 (signal 'text-read-only (list (current-buffer)))))))
2466 ;; copy-region-as-kill no longer sets this-command, because it's confusing
2467 ;; to get two copies of the text when the user accidentally types M-w and
2468 ;; then corrects it with the intended C-w.
2469 (defun copy-region-as-kill (beg end)
2470 "Save the region as if killed, but don't kill it.
2471 In Transient Mark mode, deactivate the mark.
2472 If `interprogram-cut-function' is non-nil, also save the text for a window
2473 system cut and paste."
2474 (interactive "r")
2475 (if (eq last-command 'kill-region)
2476 (kill-append (filter-buffer-substring beg end) (< end beg))
2477 (kill-new (filter-buffer-substring beg end)))
2478 (if transient-mark-mode
2479 (setq deactivate-mark t))
2480 nil)
2482 (defun kill-ring-save (beg end)
2483 "Save the region as if killed, but don't kill it.
2484 In Transient Mark mode, deactivate the mark.
2485 If `interprogram-cut-function' is non-nil, also save the text for a window
2486 system cut and paste.
2488 If you want to append the killed line to the last killed text,
2491 This command is similar to `copy-region-as-kill', except that it gives
2492 visual feedback indicating the extent of the region being copied."
2493 (interactive "r")
2494 (copy-region-as-kill beg end)
2495 ;; This use of interactive-p is correct
2496 ;; because the code it controls just gives the user visual feedback.
2497 (if (interactive-p)
2498 (let ((other-end (if (= (point) beg) end beg))
2499 (opoint (point))
2500 ;; Inhibit quitting so we can make a quit here
2501 ;; look like a C-g typed as a command.
2502 (inhibit-quit t))
2503 (if (pos-visible-in-window-p other-end (selected-window))
2504 (unless (and transient-mark-mode
2505 (face-background 'region))
2506 ;; Swap point and mark.
2507 (set-marker (mark-marker) (point) (current-buffer))
2508 (goto-char other-end)
2509 (sit-for blink-matching-delay)
2510 ;; Swap back.
2511 (set-marker (mark-marker) other-end (current-buffer))
2512 (goto-char opoint)
2513 ;; If user quit, deactivate the mark
2514 ;; as C-g would as a command.
2515 (and quit-flag mark-active
2516 (deactivate-mark)))
2517 (let* ((killed-text (current-kill 0))
2518 (message-len (min (length killed-text) 40)))
2519 (if (= (point) beg)
2520 ;; Don't say "killed"; that is misleading.
2522 (substring killed-text (- message-len)))
2524 (substring killed-text 0 message-len))))))))
2526 (defun append-next-kill (&optional interactive)
2527 "Cause following command, if it kills, to append to previous kill.
2528 The argument is used for internal purposes; do not supply one."
2529 (interactive "p")
2530 ;; We don't use (interactive-p), since that breaks kbd macros.
2531 (if interactive
2532 (progn
2533 (setq this-command 'kill-region)
2534 (message "If the next command is a kill, it will append"))
2535 (setq last-command 'kill-region)))
2536 \f
2537 ;; Yanking.
2539 ;; This is actually used in subr.el but defcustom does not work there.
2540 (defcustom yank-excluded-properties
2541 '(read-only invisible intangible field mouse-face help-echo local-map keymap
2542 yank-handler)
2543 "*Text properties to discard when yanking.
2544 The value should be a list of text properties to discard or t,
2545 which means to discard all text properties."
2546 :type '(choice (const :tag "All" t) (repeat symbol))
2547 :group 'killing
2548 :version "22.1")
2550 (defvar yank-window-start nil)
2551 (defvar yank-undo-function nil
2552 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
2553 Function is called with two parameters, START and END corresponding to
2554 the value of the mark and point; it is guaranteed that START <= END.
2555 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
2557 (defun yank-pop (&optional arg)
2558 "Replace just-yanked stretch of killed text with a different stretch.
2559 This command is allowed only immediately after a `yank' or a `yank-pop'.
2560 At such a time, the region contains a stretch of reinserted
2561 previously-killed text. `yank-pop' deletes that text and inserts in its
2562 place a different stretch of killed text.
2564 With no argument, the previous kill is inserted.
2565 With argument N, insert the Nth previous kill.
2566 If N is negative, this is a more recent kill.
2568 The sequence of kills wraps around, so that after the oldest one
2569 comes the newest one."
2570 (interactive "*p")
2571 (if (not (eq last-command 'yank))
2572 (error "Previous command was not a yank"))
2573 (setq this-command 'yank)
2574 (unless arg (setq arg 1))
2575 (let ((inhibit-read-only t)
2576 (before (< (point) (mark t))))
2577 (if before
2578 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
2579 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
2580 (setq yank-undo-function nil)
2581 (set-marker (mark-marker) (point) (current-buffer))
2582 (insert-for-yank (current-kill arg))
2583 ;; Set the window start back where it was in the yank command,
2584 ;; if possible.
2585 (set-window-start (selected-window) yank-window-start t)
2586 (if before
2587 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
2588 ;; It is cleaner to avoid activation, even though the command
2589 ;; loop would deactivate the mark because we inserted text.
2590 (goto-char (prog1 (mark t)
2591 (set-marker (mark-marker) (point) (current-buffer))))))
2592 nil)
2594 (defun yank (&optional arg)
2595 "Reinsert the last stretch of killed text.
2596 More precisely, reinsert the stretch of killed text most recently
2597 killed OR yanked. Put point at end, and set mark at beginning.
2598 With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
2599 With argument N, reinsert the Nth most recently killed stretch of killed
2600 text.
2602 (interactive "*P")
2603 (setq yank-window-start (window-start))
2604 ;; If we don't get all the way thru, make last-command indicate that
2605 ;; for the following command.
2606 (setq this-command t)
2607 (push-mark (point))
2608 (insert-for-yank (current-kill (cond
2609 ((listp arg) 0)
2610 ((eq arg '-) -2)
2611 (t (1- arg)))))
2612 (if (consp arg)
2613 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
2614 ;; It is cleaner to avoid activation, even though the command
2615 ;; loop would deactivate the mark because we inserted text.
2616 (goto-char (prog1 (mark t)
2617 (set-marker (mark-marker) (point) (current-buffer)))))
2618 ;; If we do get all the way thru, make this-command indicate that.
2619 (if (eq this-command t)
2620 (setq this-command 'yank))
2621 nil)
2623 (defun rotate-yank-pointer (arg)
2624 "Rotate the yanking point in the kill ring.
2625 With argument, rotate that many kills forward (or backward, if negative)."
2626 (interactive "p")
2627 (current-kill arg))
2628 \f
2629 ;; Some kill commands.
2631 ;; Internal subroutine of delete-char
2632 (defun kill-forward-chars (arg)
2633 (if (listp arg) (setq arg (car arg)))
2634 (if (eq arg '-) (setq arg -1))
2635 (kill-region (point) (forward-point arg)))
2637 ;; Internal subroutine of backward-delete-char
2638 (defun kill-backward-chars (arg)
2639 (if (listp arg) (setq arg (car arg)))
2640 (if (eq arg '-) (setq arg -1))
2641 (kill-region (point) (forward-point (- arg))))
2643 (defcustom backward-delete-char-untabify-method 'untabify
2644 "*The method for untabifying when deleting backward.
2645 Can be `untabify' -- turn a tab to many spaces, then delete one space;
2646 `hungry' -- delete all whitespace, both tabs and spaces;
2647 `all' -- delete all whitespace, including tabs, spaces and newlines;
2648 nil -- just delete one character."
2649 :type '(choice (const untabify) (const hungry) (const all) (const nil))
2650 :version "20.3"
2651 :group 'killing)
2653 (defun backward-delete-char-untabify (arg &optional killp)
2654 "Delete characters backward, changing tabs into spaces.
2655 The exact behavior depends on `backward-delete-char-untabify-method'.
2656 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
2657 Interactively, ARG is the prefix arg (default 1)
2658 and KILLP is t if a prefix arg was specified."
2660 (when (eq backward-delete-char-untabify-method 'untabify)
2661 (let ((count arg))
2662 (save-excursion
2663 (while (and (> count 0) (not (bobp)))
2665 (let ((col (current-column)))
2666 (forward-char -1)
2667 (setq col (- col (current-column)))
2668 (insert-char ?\ col)
2669 (delete-char 1)))
2670 (forward-char -1)
2671 (setq count (1- count))))))
2672 (delete-backward-char
2674 ((eq backward-delete-char-untabify-method 'all)
2676 (if skip
2677 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
2678 (point)))))
2679 (+ arg (if (zerop wh) 0 (1- wh))))
2680 arg))
2681 killp))
2683 (defun zap-to-char (arg char)
2684 "Kill up to and including ARG'th occurrence of CHAR.
2685 Case is ignored if `case-fold-search' is non-nil in the current buffer.
2686 Goes backward if ARG is negative; error if CHAR not found."
2688 (kill-region (point) (progn
2689 (search-forward (char-to-string char) nil nil arg)
2690 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
2691 (point))))
2693 ;; kill-line and its subroutines.
2695 (defcustom kill-whole-line nil
2696 "*If non-nil, `kill-line' with no arg at beg of line kills the whole line."
2697 :type 'boolean
2698 :group 'killing)
2700 (defun kill-line (&optional arg)
2701 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
2702 With prefix argument, kill that many lines from point.
2703 Negative arguments kill lines backward.
2704 With zero argument, kills the text before point on the current line.
2707 a number counts as a prefix arg.
2709 To kill a whole line, when point is not at the beginning, type \
2712 If `kill-whole-line' is non-nil, then this command kills the whole line
2713 including its terminating newline, when used at the beginning of a line
2714 with no argument. As a consequence, you can always kill a whole line
2717 If you want to append the killed line to the last killed text,
2720 If the buffer is read-only, Emacs will beep and refrain from deleting
2721 the line, but put the line in the kill ring anyway. This means that
2722 you can use this command to copy text from a read-only buffer.
2723 \(If the variable `kill-read-only-ok' is non-nil, then this won't
2724 even beep.)"
2725 (interactive "P")
2726 (kill-region (point)
2727 ;; It is better to move point to the other end of the kill
2728 ;; before killing. That way, in a read-only buffer, point
2729 ;; moves across the text that is copied to the kill ring.
2730 ;; The choice has no effect on undo now that undo records
2731 ;; the value of point from before the command was run.
2732 (progn
2733 (if arg
2734 (forward-visible-line (prefix-numeric-value arg))
2735 (if (eobp)
2736 (signal 'end-of-buffer nil))
2737 (let ((end
2738 (save-excursion
2739 (end-of-visible-line) (point))))
2740 (if (or (save-excursion
2741 ;; If trailing whitespace is visible,
2742 ;; don't treat it as nothing.
2743 (unless show-trailing-whitespace
2745 (= (point) end))
2746 (and kill-whole-line (bolp)))
2747 (forward-visible-line 1)
2748 (goto-char end))))
2749 (point))))
2751 (defun kill-whole-line (&optional arg)
2752 "Kill current line.
2753 With prefix arg, kill that many lines starting from the current line.
2754 If arg is negative, kill backward. Also kill the preceding newline.
2755 \(This is meant to make C-x z work well with negative arguments.\)
2756 If arg is zero, kill current line but exclude the trailing newline."
2757 (interactive "p")
2758 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
2759 (signal 'end-of-buffer nil))
2760 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
2761 (signal 'beginning-of-buffer nil))
2762 (unless (eq last-command 'kill-region)
2763 (kill-new "")
2764 (setq last-command 'kill-region))
2765 (cond ((zerop arg)
2766 ;; We need to kill in two steps, because the previous command
2767 ;; could have been a kill command, in which case the text
2768 ;; before point needs to be prepended to the current kill
2769 ;; ring entry and the text after point appended. Also, we
2770 ;; need to use save-excursion to avoid copying the same text
2771 ;; twice to the kill ring in read-only buffers.
2772 (save-excursion
2773 (kill-region (point) (progn (forward-visible-line 0) (point))))
2774 (kill-region (point) (progn (end-of-visible-line) (point))))
2775 ((< arg 0)
2776 (save-excursion
2777 (kill-region (point) (progn (end-of-visible-line) (point))))
2778 (kill-region (point)
2779 (progn (forward-visible-line (1+ arg))
2780 (unless (bobp) (backward-char))
2781 (point))))
2782 (t
2783 (save-excursion
2784 (kill-region (point) (progn (forward-visible-line 0) (point))))
2785 (kill-region (point)
2786 (progn (forward-visible-line arg) (point))))))
2788 (defun forward-visible-line (arg)
2789 "Move forward by ARG lines, ignoring currently invisible newlines only.
2790 If ARG is negative, move backward -ARG lines.
2791 If ARG is zero, move to the beginning of the current line."
2792 (condition-case nil
2793 (if (> arg 0)
2794 (progn
2795 (while (> arg 0)
2796 (or (zerop (forward-line 1))
2797 (signal 'end-of-buffer nil))
2798 ;; If the newline we just skipped is invisible,
2799 ;; don't count it.
2800 (let ((prop
2801 (get-char-property (1- (point)) 'invisible)))
2802 (if (if (eq buffer-invisibility-spec t)
2803 prop
2804 (or (memq prop buffer-invisibility-spec)
2805 (assq prop buffer-invisibility-spec)))
2806 (setq arg (1+ arg))))
2807 (setq arg (1- arg)))
2808 ;; If invisible text follows, and it is a number of complete lines,
2809 ;; skip it.
2810 (let ((opoint (point)))
2811 (while (and (not (eobp))
2812 (let ((prop
2813 (get-char-property (point) 'invisible)))
2814 (if (eq buffer-invisibility-spec t)
2815 prop
2816 (or (memq prop buffer-invisibility-spec)
2817 (assq prop buffer-invisibility-spec)))))
2818 (goto-char
2819 (if (get-text-property (point) 'invisible)
2820 (or (next-single-property-change (point) 'invisible)
2821 (point-max))
2822 (next-overlay-change (point)))))
2823 (unless (bolp)
2824 (goto-char opoint))))
2825 (let ((first t))
2826 (while (or first (<= arg 0))
2827 (if first
2828 (beginning-of-line)
2829 (or (zerop (forward-line -1))
2830 (signal 'beginning-of-buffer nil)))
2831 ;; If the newline we just moved to is invisible,
2832 ;; don't count it.
2833 (unless (bobp)
2834 (let ((prop
2835 (get-char-property (1- (point)) 'invisible)))
2836 (unless (if (eq buffer-invisibility-spec t)
2837 prop
2838 (or (memq prop buffer-invisibility-spec)
2839 (assq prop buffer-invisibility-spec)))
2840 (setq arg (1+ arg)))))
2841 (setq first nil))
2842 ;; If invisible text follows, and it is a number of complete lines,
2843 ;; skip it.
2844 (let ((opoint (point)))
2845 (while (and (not (bobp))
2846 (let ((prop
2847 (get-char-property (1- (point)) 'invisible)))
2848 (if (eq buffer-invisibility-spec t)
2849 prop
2850 (or (memq prop buffer-invisibility-spec)
2851 (assq prop buffer-invisibility-spec)))))
2852 (goto-char
2853 (if (get-text-property (1- (point)) 'invisible)
2854 (or (previous-single-property-change (point) 'invisible)
2855 (point-min))
2856 (previous-overlay-change (point)))))
2857 (unless (bolp)
2858 (goto-char opoint)))))
2859 ((beginning-of-buffer end-of-buffer)
2860 nil)))
2862 (defun end-of-visible-line ()
2863 "Move to end of current visible line."
2864 (end-of-line)
2865 ;; If the following character is currently invisible,
2866 ;; skip all characters with that same `invisible' property value,
2867 ;; then find the next newline.
2868 (while (and (not (eobp))
2869 (save-excursion
2871 (let ((prop
2872 (get-char-property (point) 'invisible)))
2873 (if (eq buffer-invisibility-spec t)
2874 prop
2875 (or (memq prop buffer-invisibility-spec)
2876 (assq prop buffer-invisibility-spec))))))
2878 (if (get-text-property (point) 'invisible)
2879 (goto-char (next-single-property-change (point) 'invisible))
2880 (goto-char (next-overlay-change (point))))
2881 (end-of-line)))
2882 \f
2883 (defun insert-buffer (buffer)
2884 "Insert after point the contents of BUFFER.
2885 Puts mark after the inserted text.
2886 BUFFER may be a buffer or a buffer name.
2888 This function is meant for the user to run interactively.
2889 Don't call it from programs: use `insert-buffer-substring' instead!"
2890 (interactive
2891 (list
2892 (progn
2893 (barf-if-buffer-read-only)
2894 (read-buffer "Insert buffer: "
2895 (if (eq (selected-window) (next-window (selected-window)))
2896 (other-buffer (current-buffer))
2897 (window-buffer (next-window (selected-window))))
2898 t))))
2899 (push-mark
2900 (save-excursion
2901 (insert-buffer-substring (get-buffer buffer))
2902 (point)))
2903 nil)
2905 (defun append-to-buffer (buffer start end)
2906 "Append to specified buffer the text of the region.
2907 It is inserted into that buffer before its point.
2909 When calling from a program, give three arguments:
2910 BUFFER (or buffer name), START and END.
2911 START and END specify the portion of the current buffer to be copied."
2912 (interactive
2913 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
2914 (region-beginning) (region-end)))
2915 (let ((oldbuf (current-buffer)))
2916 (save-excursion
2917 (let* ((append-to (get-buffer-create buffer))
2918 (windows (get-buffer-window-list append-to t t))
2919 point)
2920 (set-buffer append-to)
2921 (setq point (point))
2922 (barf-if-buffer-read-only)
2923 (insert-buffer-substring oldbuf start end)
2924 (dolist (window windows)
2925 (when (= (window-point window) point)
2926 (set-window-point window (point))))))))
2928 (defun prepend-to-buffer (buffer start end)
2929 "Prepend to specified buffer the text of the region.
2930 It is inserted into that buffer after its point.
2932 When calling from a program, give three arguments:
2933 BUFFER (or buffer name), START and END.
2934 START and END specify the portion of the current buffer to be copied."
2936 (let ((oldbuf (current-buffer)))
2937 (save-excursion
2938 (set-buffer (get-buffer-create buffer))
2939 (barf-if-buffer-read-only)
2940 (save-excursion
2941 (insert-buffer-substring oldbuf start end)))))
2943 (defun copy-to-buffer (buffer start end)
2944 "Copy to specified buffer the text of the region.
2945 It is inserted into that buffer, replacing existing text there.
2947 When calling from a program, give three arguments:
2948 BUFFER (or buffer name), START and END.
2949 START and END specify the portion of the current buffer to be copied."
2951 (let ((oldbuf (current-buffer)))
2952 (save-excursion
2953 (set-buffer (get-buffer-create buffer))
2954 (barf-if-buffer-read-only)
2955 (erase-buffer)
2956 (save-excursion
2957 (insert-buffer-substring oldbuf start end)))))
2958 \f
2959 (put 'mark-inactive 'error-conditions '(mark-inactive error))
2960 (put 'mark-inactive 'error-message "The mark is not active now")
2962 (defvar activate-mark-hook nil
2963 "Hook run when the mark becomes active.
2964 It is also run at the end of a command, if the mark is active and
2965 it is possible that the region may have changed")
2967 (defvar deactivate-mark-hook nil
2968 "Hook run when the mark becomes inactive.")
2970 (defun mark (&optional force)
2971 "Return this buffer's mark value as integer; error if mark inactive.
2972 If optional argument FORCE is non-nil, access the mark value
2973 even if the mark is not currently active, and return nil
2974 if there is no mark at all.
2976 If you are using this in an editing command, you are most likely making
2977 a mistake; see the documentation of `set-mark'."
2978 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
2979 (marker-position (mark-marker))
2980 (signal 'mark-inactive nil)))
2982 ;; Many places set mark-active directly, and several of them failed to also
2983 ;; run deactivate-mark-hook. This shorthand should simplify.
2984 (defsubst deactivate-mark ()
2985 "Deactivate the mark by setting `mark-active' to nil.
2986 \(That makes a difference only in Transient Mark mode.)
2987 Also runs the hook `deactivate-mark-hook'."
2988 (cond
2989 ((eq transient-mark-mode 'lambda)
2990 (setq transient-mark-mode nil))
2991 (transient-mark-mode
2992 (setq mark-active nil)
2993 (run-hooks 'deactivate-mark-hook))))
2995 (defun set-mark (pos)
2996 "Set this buffer's mark to POS. Don't use this function!
2997 That is to say, don't use this function unless you want
2998 the user to see that the mark has moved, and you want the previous
2999 mark position to be lost.
3001 Normally, when a new mark is set, the old one should go on the stack.
3002 This is why most applications should use `push-mark', not `set-mark'.
3004 Novice Emacs Lisp programmers often try to use the mark for the wrong
3005 purposes. The mark saves a location for the user's convenience.
3006 Most editing commands should not alter the mark.
3007 To remember a location for internal use in the Lisp program,
3008 store it in a Lisp variable. Example:
3010 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
3012 (if pos
3013 (progn
3014 (setq mark-active t)
3015 (run-hooks 'activate-mark-hook)
3016 (set-marker (mark-marker) pos (current-buffer)))
3017 ;; Normally we never clear mark-active except in Transient Mark mode.
3018 ;; But when we actually clear out the mark value too,
3019 ;; we must clear mark-active in any mode.
3020 (setq mark-active nil)
3021 (run-hooks 'deactivate-mark-hook)
3022 (set-marker (mark-marker) nil)))
3024 (defvar mark-ring nil
3025 "The list of former marks of the current buffer, most recent first.")
3026 (make-variable-buffer-local 'mark-ring)
3027 (put 'mark-ring 'permanent-local t)
3029 (defcustom mark-ring-max 16
3030 "*Maximum size of mark ring. Start discarding off end if gets this big."
3031 :type 'integer
3032 :group 'editing-basics)
3034 (defvar global-mark-ring nil
3035 "The list of saved global marks, most recent first.")
3037 (defcustom global-mark-ring-max 16
3038 "*Maximum size of global mark ring. \
3039 Start discarding off end if gets this big."
3040 :type 'integer
3041 :group 'editing-basics)
3043 (defun pop-to-mark-command ()
3044 "Jump to mark, and pop a new position for mark off the ring
3045 \(does not affect global mark ring\)."
3046 (interactive)
3047 (if (null (mark t))
3048 (error "No mark set in this buffer")
3049 (goto-char (mark t))
3050 (pop-mark)))
3052 (defun push-mark-command (arg &optional nomsg)
3053 "Set mark at where point is.
3054 If no prefix arg and mark is already set there, just activate it.
3055 Display `Mark set' unless the optional second arg NOMSG is non-nil."
3056 (interactive "P")
3057 (let ((mark (marker-position (mark-marker))))
3058 (if (or arg (null mark) (/= mark (point)))
3059 (push-mark nil nomsg t)
3060 (setq mark-active t)
3061 (run-hooks 'activate-mark-hook)
3062 (unless nomsg
3063 (message "Mark activated")))))
3065 (defun set-mark-command (arg)
3066 "Set mark at where point is, or jump to mark.
3067 With no prefix argument, set mark, and push old mark position on local
3068 mark ring; also push mark on global mark ring if last mark was set in
3069 another buffer. Immediately repeating the command activates
3070 `transient-mark-mode' temporarily.
3073 jump to mark, and pop a new position
3074 for mark off the local mark ring \(this does not affect the global
3076 mark ring \(see `pop-global-mark'\).
3079 the next position off the local (or global) mark ring.
3083 set mark where point is.
3085 Novice Emacs Lisp programmers often try to use the mark for the wrong
3086 purposes. See the documentation of `set-mark' for more information."
3087 (interactive "P")
3088 (if (eq transient-mark-mode 'lambda)
3089 (setq transient-mark-mode nil))
3090 (cond
3091 ((and (consp arg) (> (prefix-numeric-value arg) 4))
3092 (push-mark-command nil))
3093 ((not (eq this-command 'set-mark-command))
3094 (if arg
3095 (pop-to-mark-command)
3096 (push-mark-command t)))
3097 ((eq last-command 'pop-to-mark-command)
3098 (setq this-command 'pop-to-mark-command)
3099 (pop-to-mark-command))
3100 ((and (eq last-command 'pop-global-mark) (not arg))
3101 (setq this-command 'pop-global-mark)
3102 (pop-global-mark))
3103 (arg
3104 (setq this-command 'pop-to-mark-command)
3105 (pop-to-mark-command))
3106 ((and (eq last-command 'set-mark-command)
3107 mark-active (null transient-mark-mode))
3108 (setq transient-mark-mode 'lambda)
3109 (message "Transient-mark-mode temporarily enabled"))
3110 (t
3111 (push-mark-command nil))))
3113 (defun push-mark (&optional location nomsg activate)
3114 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
3115 If the last global mark pushed was not in the current buffer,
3116 also push LOCATION on the global mark ring.
3117 Display `Mark set' unless the optional second arg NOMSG is non-nil.
3118 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil.
3120 Novice Emacs Lisp programmers often try to use the mark for the wrong
3121 purposes. See the documentation of `set-mark' for more information.
3123 In Transient Mark mode, this does not activate the mark."
3124 (unless (null (mark t))
3125 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
3126 (when (> (length mark-ring) mark-ring-max)
3127 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
3128 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
3129 (set-marker (mark-marker) (or location (point)) (current-buffer))
3130 ;; Now push the mark on the global mark ring.
3131 (if (and global-mark-ring
3132 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
3133 ;; The last global mark pushed was in this same buffer.
3134 ;; Don't push another one.
3135 nil
3136 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
3137 (when (> (length global-mark-ring) global-mark-ring-max)
3138 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
3139 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
3140 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
3141 (message "Mark set"))
3142 (if (or activate (not transient-mark-mode))
3143 (set-mark (mark t)))
3144 nil)
3146 (defun pop-mark ()
3147 "Pop off mark ring into the buffer's actual mark.
3148 Does not set point. Does nothing if mark ring is empty."
3149 (when mark-ring
3150 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
3151 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
3152 (move-marker (car mark-ring) nil)
3153 (if (null (mark t)) (ding))
3154 (setq mark-ring (cdr mark-ring)))
3155 (deactivate-mark))
3157 (defalias 'exchange-dot-and-mark 'exchange-point-and-mark)
3158 (defun exchange-point-and-mark (&optional arg)
3159 "Put the mark where point is now, and point where the mark is now.
3160 This command works even when the mark is not active,
3161 and it reactivates the mark.
3162 With prefix arg, `transient-mark-mode' is enabled temporarily."
3163 (interactive "P")
3164 (if arg
3165 (if mark-active
3166 (if (null transient-mark-mode)
3167 (setq transient-mark-mode 'lambda))
3168 (setq arg nil)))
3169 (unless arg
3170 (let ((omark (mark t)))
3171 (if (null omark)
3172 (error "No mark set in this buffer"))
3173 (set-mark (point))
3174 (goto-char omark)
3175 nil)))
3177 (define-minor-mode transient-mark-mode
3178 "Toggle Transient Mark mode.
3179 With arg, turn Transient Mark mode on if arg is positive, off otherwise.
3181 In Transient Mark mode, when the mark is active, the region is highlighted.
3183 So do certain other operations that set the mark
3184 but whose main purpose is something else--for example,
3190 Many commands change their behavior when Transient Mark mode is in effect
3191 and the mark is active, by acting on the region instead of their usual
3192 default part of the buffer's text. Examples of such commands include
3197 commands which are sensitive to the Transient Mark mode."
3198 :global t :group 'editing-basics :require nil)
3200 (defun pop-global-mark ()
3201 "Pop off global mark ring and jump to the top location."
3202 (interactive)
3203 ;; Pop entries which refer to non-existent buffers.
3204 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
3205 (setq global-mark-ring (cdr global-mark-ring)))
3206 (or global-mark-ring
3207 (error "No global mark set"))
3208 (let* ((marker (car global-mark-ring))
3209 (buffer (marker-buffer marker))
3210 (position (marker-position marker)))
3211 (setq global-mark-ring (nconc (cdr global-mark-ring)
3212 (list (car global-mark-ring))))
3213 (set-buffer buffer)
3214 (or (and (>= position (point-min))
3215 (<= position (point-max)))
3216 (widen))
3217 (goto-char position)
3218 (switch-to-buffer buffer)))
3219 \f
3220 (defcustom next-line-add-newlines nil
3221 "*If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
3222 :type 'boolean
3223 :version "21.1"
3224 :group 'editing-basics)
3226 (defun next-line (&optional arg try-vscroll)
3227 "Move cursor vertically down ARG lines.
3228 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
3229 If there is no character in the target line exactly under the current column,
3230 the cursor is positioned after the character in that line which spans this
3231 column, or at the end of the line if it is not long enough.
3232 If there is no line in the buffer after this one, behavior depends on the
3233 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
3234 to create a line, and moves the cursor to that line. Otherwise it moves the
3235 cursor to the end of the buffer.
3238 a semipermanent goal column for this command.
3239 Then instead of trying to move exactly vertically (or as close as possible),
3240 this command moves to the specified goal column (or as close as possible).
3241 The goal column is stored in the variable `goal-column', which is nil
3242 when there is no goal column.
3244 If you are thinking of using this in a Lisp program, consider
3245 using `forward-line' instead. It is usually easier to use
3246 and more reliable (no dependence on goal column, etc.)."
3248 (or arg (setq arg 1))
3249 (if (and next-line-add-newlines (= arg 1))
3250 (if (save-excursion (end-of-line) (eobp))
3251 ;; When adding a newline, don't expand an abbrev.
3252 (let ((abbrev-mode nil))
3253 (end-of-line)
3255 (line-move arg nil nil try-vscroll))
3256 (if (interactive-p)
3257 (condition-case nil
3258 (line-move arg nil nil try-vscroll)
3259 ((beginning-of-buffer end-of-buffer) (ding)))
3260 (line-move arg nil nil try-vscroll)))
3261 nil)
3263 (defun previous-line (&optional arg try-vscroll)
3264 "Move cursor vertically up ARG lines.
3265 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
3266 If there is no character in the target line exactly over the current column,
3267 the cursor is positioned after the character in that line which spans this
3268 column, or at the end of the line if it is not long enough.
3271 a semipermanent goal column for this command.
3272 Then instead of trying to move exactly vertically (or as close as possible),
3273 this command moves to the specified goal column (or as close as possible).
3274 The goal column is stored in the variable `goal-column', which is nil
3275 when there is no goal column.
3277 If you are thinking of using this in a Lisp program, consider using
3278 `forward-line' with a negative argument instead. It is usually easier
3279 to use and more reliable (no dependence on goal column, etc.)."
3281 (or arg (setq arg 1))
3282 (if (interactive-p)
3283 (condition-case nil
3284 (line-move (- arg) nil nil try-vscroll)
3285 ((beginning-of-buffer end-of-buffer) (ding)))
3286 (line-move (- arg) nil nil try-vscroll))
3287 nil)
3289 (defcustom track-eol nil
3290 "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
3291 This means moving to the end of each line moved onto.
3292 The beginning of a blank line does not count as the end of a line."
3293 :type 'boolean
3294 :group 'editing-basics)
3296 (defcustom goal-column nil
3298 :type '(choice integer
3299 (const :tag "None" nil))
3300 :group 'editing-basics)
3301 (make-variable-buffer-local 'goal-column)
3303 (defvar temporary-goal-column 0
3304 "Current goal column for vertical motion.
3305 It is the column where point was
3306 at the start of current run of vertical motion commands.
3307 When the `track-eol' feature is doing its job, the value is 9999.")
3309 (defcustom line-move-ignore-invisible t
3311 Outline mode sets this."
3312 :type 'boolean
3313 :group 'editing-basics)
3315 (defun line-move-invisible-p (pos)
3316 "Return non-nil if the character after POS is currently invisible."
3317 (let ((prop
3318 (get-char-property pos 'invisible)))
3319 (if (eq buffer-invisibility-spec t)
3320 prop
3321 (or (memq prop buffer-invisibility-spec)
3322 (assq prop buffer-invisibility-spec)))))
3324 ;; Perform vertical scrolling of tall images if necessary.
3325 ;; Don't vscroll in a keyboard macro.
3326 (defun line-move (arg &optional noerror to-end try-vscroll)
3327 (if (and auto-window-vscroll try-vscroll
3328 (not defining-kbd-macro)
3329 (not executing-kbd-macro))
3330 (let ((forward (> arg 0))
3331 (part (nth 2 (pos-visible-in-window-p (point) nil t))))
3332 (if (and (consp part)
3333 (> (setq part (if forward (cdr part) (car part))) 0))
3334 (set-window-vscroll nil
3335 (if forward
3336 (+ (window-vscroll nil t)
3337 (min part
3338 (* (frame-char-height) arg)))
3339 (max 0
3340 (- (window-vscroll nil t)
3341 (min part
3342 (* (frame-char-height) (- arg))))))
3343 t)
3344 (set-window-vscroll nil 0)
3345 (when (line-move-1 arg noerror to-end)
3346 (sit-for 0)
3347 (if (and (not forward)
3348 (setq part (nth 2 (pos-visible-in-window-p
3349 (line-beginning-position) nil t)))
3350 (> (cdr part) 0))
3351 (set-window-vscroll nil (cdr part) t))
3352 t)))
3353 (line-move-1 arg noerror to-end)))
3355 ;; This is the guts of next-line and previous-line.
3356 ;; Arg says how many lines to move.
3357 ;; The value is t if we can move the specified number of lines.
3358 (defun line-move-1 (arg &optional noerror to-end)
3359 ;; Don't run any point-motion hooks, and disregard intangibility,
3360 ;; for intermediate positions.
3361 (let ((inhibit-point-motion-hooks t)
3362 (opoint (point))
3363 (forward (> arg 0)))
3364 (unwind-protect
3365 (progn
3366 (if (not (memq last-command '(next-line previous-line)))
3367 (setq temporary-goal-column
3368 (if (and track-eol (eolp)
3369 ;; Don't count beg of empty line as end of line
3370 ;; unless we just did explicit end-of-line.
3371 (or (not (bolp)) (eq last-command 'end-of-line)))
3372 9999
3373 (current-column))))
3375 (if (and (not (integerp selective-display))
3376 (not line-move-ignore-invisible))
3377 ;; Use just newline characters.
3378 ;; Set ARG to 0 if we move as many lines as requested.
3379 (or (if (> arg 0)
3380 (progn (if (> arg 1) (forward-line (1- arg)))
3381 ;; This way of moving forward ARG lines
3382 ;; verifies that we have a newline after the last one.
3383 ;; It doesn't get confused by intangible text.
3384 (end-of-line)
3385 (if (zerop (forward-line 1))
3386 (setq arg 0)))
3387 (and (zerop (forward-line arg))
3388 (bolp)
3389 (setq arg 0)))
3390 (unless noerror
3391 (signal (if (< arg 0)
3392 'beginning-of-buffer
3393 'end-of-buffer)
3394 nil)))
3395 ;; Move by arg lines, but ignore invisible ones.
3396 (let (done)
3397 (while (and (> arg 0) (not done))
3398 ;; If the following character is currently invisible,
3399 ;; skip all characters with that same `invisible' property value.
3400 (while (and (not (eobp)) (line-move-invisible-p (point)))
3401 (goto-char (next-char-property-change (point))))
3402 ;; Now move a line.
3403 (end-of-line)
3404 (and (zerop (vertical-motion 1))
3405 (if (not noerror)
3406 (signal 'end-of-buffer nil)
3407 (setq done t)))
3408 (unless done
3409 (setq arg (1- arg))))
3410 (while (and (< arg 0) (not done))
3411 (beginning-of-line)
3413 (if (zerop (vertical-motion -1))
3414 (if (not noerror)
3415 (signal 'beginning-of-buffer nil)
3416 (setq done t)))
3417 (unless done
3418 (setq arg (1+ arg))
3419 (while (and ;; Don't move over previous invis lines
3420 ;; if our target is the middle of this line.
3421 (or (zerop (or goal-column temporary-goal-column))
3422 (< arg 0))
3423 (not (bobp)) (line-move-invisible-p (1- (point))))
3424 (goto-char (previous-char-property-change (point))))))))
3425 ;; This is the value the function returns.
3426 (= arg 0))
3428 (cond ((> arg 0)
3429 ;; If we did not move down as far as desired,
3430 ;; at least go to end of line.
3431 (end-of-line))
3432 ((< arg 0)
3433 ;; If we did not move down as far as desired,
3434 ;; at least go to end of line.
3435 (beginning-of-line))
3436 (t
3437 (line-move-finish (or goal-column temporary-goal-column)
3438 opoint forward))))))
3440 (defun line-move-finish (column opoint forward)
3441 (let ((repeat t))
3442 (while repeat
3443 ;; Set REPEAT to t to repeat the whole thing.
3444 (setq repeat nil)
3446 (let (new
3447 (line-beg (save-excursion (beginning-of-line) (point)))
3448 (line-end
3449 ;; Compute the end of the line
3450 ;; ignoring effectively invisible newlines.
3451 (save-excursion
3452 (end-of-line)
3453 (while (and (not (eobp)) (line-move-invisible-p (point)))
3454 (goto-char (next-char-property-change (point)))
3455 (end-of-line))
3456 (point))))
3458 ;; Move to the desired column.
3459 (line-move-to-column column)
3460 (setq new (point))
3462 ;; Process intangibility within a line.
3463 ;; Move to the chosen destination position from above,
3464 ;; with intangibility processing enabled.
3466 (goto-char (point-min))
3467 (let ((inhibit-point-motion-hooks nil))
3468 (goto-char new)
3470 ;; If intangibility moves us to a different (later) place
3471 ;; in the same line, use that as the destination.
3472 (if (<= (point) line-end)
3473 (setq new (point))
3474 ;; If that position is "too late",
3475 ;; try the previous allowable position.
3476 ;; See if it is ok.
3477 (backward-char)
3478 (if (if forward
3479 ;; If going forward, don't accept the previous
3480 ;; allowable position if it is before the target line.
3481 (< line-beg (point))
3482 ;; If going backward, don't accept the previous
3483 ;; allowable position if it is still after the target line.
3484 (<= (point) line-end))
3485 (setq new (point))
3486 ;; As a last resort, use the end of the line.
3487 (setq new line-end))))
3489 ;; Now move to the updated destination, processing fields
3490 ;; as well as intangibility.
3491 (goto-char opoint)
3492 (let ((inhibit-point-motion-hooks nil))
3493 (goto-char
3494 (constrain-to-field new opoint nil t
3495 'inhibit-line-move-field-capture)))
3497 ;; If all this moved us to a different line,
3498 ;; retry everything within that new line.
3499 (when (or (< (point) line-beg) (> (point) line-end))
3500 ;; Repeat the intangibility and field processing.
3501 (setq repeat t))))))
3503 (defun line-move-to-column (col)
3504 "Try to find column COL, considering invisibility.
3505 This function works only in certain cases,
3506 because what we really need is for `move-to-column'
3507 and `current-column' to be able to ignore invisible text."
3508 (if (zerop col)
3509 (beginning-of-line)
3510 (move-to-column col))
3512 (when (and line-move-ignore-invisible
3513 (not (bolp)) (line-move-invisible-p (1- (point))))
3514 (let ((normal-location (point))
3515 (normal-column (current-column)))
3516 ;; If the following character is currently invisible,
3517 ;; skip all characters with that same `invisible' property value.
3518 (while (and (not (eobp))
3519 (line-move-invisible-p (point)))
3520 (goto-char (next-char-property-change (point))))
3521 ;; Have we advanced to a larger column position?
3522 (if (> (current-column) normal-column)
3523 ;; We have made some progress towards the desired column.
3524 ;; See if we can make any further progress.
3525 (line-move-to-column (+ (current-column) (- col normal-column)))
3526 ;; Otherwise, go to the place we originally found
3527 ;; and move back over invisible text.
3528 ;; that will get us to the same place on the screen
3529 ;; but with a more reasonable buffer position.
3530 (goto-char normal-location)
3531 (let ((line-beg (save-excursion (beginning-of-line) (point))))
3532 (while (and (not (bolp)) (line-move-invisible-p (1- (point))))
3533 (goto-char (previous-char-property-change (point) line-beg))))))))
3535 (defun move-end-of-line (arg)
3536 "Move point to end of current line.
3537 With argument ARG not nil or 1, move forward ARG - 1 lines first.
3538 If point reaches the beginning or end of buffer, it stops there.
3539 To ignore intangibility, bind `inhibit-point-motion-hooks' to t.
3541 This command does not move point across a field boundary unless doing so
3542 would move beyond there to a different line; if ARG is nil or 1, and
3543 point starts at a field boundary, point does not move. To ignore field
3544 boundaries bind `inhibit-field-text-motion' to t."
3545 (interactive "p")
3546 (or arg (setq arg 1))
3547 (let (done)
3548 (while (not done)
3549 (let ((newpos
3550 (save-excursion
3551 (let ((goal-column 0))
3552 (and (line-move arg t)
3553 (not (bobp))
3554 (progn
3555 (while (and (not (bobp)) (line-move-invisible-p (1- (point))))
3556 (goto-char (previous-char-property-change (point))))
3557 (backward-char 1)))
3558 (point)))))
3559 (goto-char newpos)
3560 (if (and (> (point) newpos)
3562 (backward-char 1)
3563 (if (and (> (point) newpos) (not (eobp))
3565 ;; If we skipped something intangible
3566 ;; and now we're not really at eol,
3567 ;; keep going.
3568 (setq arg 1)
3569 (setq done t)))))))
3571 (defun move-beginning-of-line (arg)
3572 "Move point to beginning of current display line.
3573 With argument ARG not nil or 1, move forward ARG - 1 lines first.
3574 If point reaches the beginning or end of buffer, it stops there.
3575 To ignore intangibility, bind `inhibit-point-motion-hooks' to t.
3577 This command does not move point across a field boundary unless doing so
3578 would move beyond there to a different line; if ARG is nil or 1, and
3579 point starts at a field boundary, point does not move. To ignore field
3580 boundaries bind `inhibit-field-text-motion' to t."
3581 (interactive "p")
3582 (or arg (setq arg 1))
3583 (if (/= arg 1)
3584 (line-move (1- arg) t))
3585 (beginning-of-line 1)
3586 (let ((orig (point)))
3587 (vertical-motion 0)
3588 (if (/= orig (point))
3589 (goto-char (constrain-to-field (point) orig (/= arg 1) t nil)))))
3592 ;;; Many people have said they rarely use this feature, and often type
3593 ;;; it by accident. Maybe it shouldn't even be on a key.
3594 (put 'set-goal-column 'disabled t)
3596 (defun set-goal-column (arg)
3598 Those commands will move to this position in the line moved to
3599 rather than trying to keep the same horizontal position.
3600 With a non-nil argument, clears out the goal column
3602 The goal column is stored in the variable `goal-column'."
3603 (interactive "P")
3604 (if arg
3605 (progn
3606 (setq goal-column nil)
3607 (message "No goal column"))
3608 (setq goal-column (current-column))
3609 (message (substitute-command-keys
3611 goal-column))
3612 nil)
3613 \f
3615 (defun scroll-other-window-down (lines)
3617 For more details, see the documentation for `scroll-other-window'."
3618 (interactive "P")
3619 (scroll-other-window
3620 ;; Just invert the argument's meaning.
3621 ;; We can do that without knowing which window it will be.
3622 (if (eq lines '-) nil
3623 (if (null lines) '-
3624 (- (prefix-numeric-value lines))))))
3625 (define-key esc-map [?\C-\S-v] 'scroll-other-window-down)
3627 (defun beginning-of-buffer-other-window (arg)
3628 "Move point to the beginning of the buffer in the other window.
3629 Leave mark at previous position.
3630 With arg N, put point N/10 of the way from the true beginning."
3631 (interactive "P")
3632 (let ((orig-window (selected-window))
3633 (window (other-window-for-scrolling)))
3634 ;; We use unwind-protect rather than save-window-excursion
3635 ;; because the latter would preserve the things we want to change.
3636 (unwind-protect
3637 (progn
3638 (select-window window)
3639 ;; Set point and mark in that window's buffer.
3640 (with-no-warnings
3641 (beginning-of-buffer arg))
3642 ;; Set point accordingly.
3643 (recenter '(t)))
3644 (select-window orig-window))))
3646 (defun end-of-buffer-other-window (arg)
3647 "Move point to the end of the buffer in the other window.
3648 Leave mark at previous position.
3649 With arg N, put point N/10 of the way from the true end."
3650 (interactive "P")
3651 ;; See beginning-of-buffer-other-window for comments.
3652 (let ((orig-window (selected-window))
3653 (window (other-window-for-scrolling)))
3654 (unwind-protect
3655 (progn
3656 (select-window window)
3657 (with-no-warnings
3658 (end-of-buffer arg))
3659 (recenter '(t)))
3660 (select-window orig-window))))
3661 \f
3662 (defun transpose-chars (arg)
3663 "Interchange characters around point, moving forward one character.
3664 With prefix arg ARG, effect is to take character before point
3665 and drag it forward past ARG other characters (backward if ARG negative).
3666 If no argument and at end of line, the previous two chars are exchanged."
3667 (interactive "*P")
3668 (and (null arg) (eolp) (forward-char -1))
3669 (transpose-subr 'forward-char (prefix-numeric-value arg)))
3671 (defun transpose-words (arg)
3672 "Interchange words around point, leaving point at end of them.
3673 With prefix arg ARG, effect is to take word before or around point
3674 and drag it forward past ARG other words (backward if ARG negative).
3675 If ARG is zero, the words around or after point and around or after mark
3676 are interchanged."
3677 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
3678 (interactive "*p")
3679 (transpose-subr 'forward-word arg))
3681 (defun transpose-sexps (arg)
3683 Does not work on a sexp that point is in the middle of
3684 if it is a list or string."
3685 (interactive "*p")
3686 (transpose-subr
3687 (lambda (arg)
3688 ;; Here we should try to simulate the behavior of
3689 ;; (cons (progn (forward-sexp x) (point))
3690 ;; (progn (forward-sexp (- x)) (point)))
3691 ;; Except that we don't want to rely on the second forward-sexp
3692 ;; putting us back to where we want to be, since forward-sexp-function
3693 ;; might do funny things like infix-precedence.
3694 (if (if (> arg 0)
3696 (and (not (bobp))
3698 ;; Jumping over a symbol. We might be inside it, mind you.
3699 (progn (funcall (if (> arg 0)
3700 'skip-syntax-backward 'skip-syntax-forward)
3701 "w_")
3702 (cons (save-excursion (forward-sexp arg) (point)) (point)))
3703 ;; Otherwise, we're between sexps. Take a step back before jumping
3704 ;; to make sure we'll obey the same precedence no matter which direction
3705 ;; we're going.
3706 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
3707 (cons (save-excursion (forward-sexp arg) (point))
3708 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
3709 (not (zerop (funcall (if (> arg 0)
3710 'skip-syntax-forward
3711 'skip-syntax-backward)
3712 ".")))))
3713 (point)))))
3714 arg 'special))
3716 (defun transpose-lines (arg)
3717 "Exchange current line and previous line, leaving point after both.
3718 With argument ARG, takes previous line and moves it past ARG lines.
3719 With argument 0, interchanges line point is in with line mark is in."
3720 (interactive "*p")
3721 (transpose-subr (function
3722 (lambda (arg)
3723 (if (> arg 0)
3724 (progn
3725 ;; Move forward over ARG lines,
3726 ;; but create newlines if necessary.
3727 (setq arg (forward-line arg))
3729 (setq arg (1+ arg)))
3730 (if (> arg 0)
3731 (newline arg)))
3732 (forward-line arg))))
3733 arg))
3735 (defun transpose-subr (mover arg &optional special)
3736 (let ((aux (if special mover
3737 (lambda (x)
3738 (cons (progn (funcall mover x) (point))
3739 (progn (funcall mover (- x)) (point))))))
3740 pos1 pos2)
3741 (cond
3742 ((= arg 0)
3743 (save-excursion
3744 (setq pos1 (funcall aux 1))
3745 (goto-char (mark))
3746 (setq pos2 (funcall aux 1))
3747 (transpose-subr-1 pos1 pos2))
3748 (exchange-point-and-mark))
3749 ((> arg 0)
3750 (setq pos1 (funcall aux -1))
3751 (setq pos2 (funcall aux arg))
3752 (transpose-subr-1 pos1 pos2)
3753 (goto-char (car pos2)))
3754 (t
3755 (setq pos1 (funcall aux -1))
3756 (goto-char (car pos1))
3757 (setq pos2 (funcall aux arg))
3758 (transpose-subr-1 pos1 pos2)))))
3760 (defun transpose-subr-1 (pos1 pos2)
3761 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
3762 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
3763 (when (> (car pos1) (car pos2))
3764 (let ((swap pos1))
3765 (setq pos1 pos2 pos2 swap)))
3766 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
3767 (atomic-change-group
3768 (let (word2)
3769 ;; FIXME: We first delete the two pieces of text, so markers that
3770 ;; used to point to after the text end up pointing to before it :-(
3771 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
3772 (goto-char (car pos2))
3773 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
3774 (goto-char (car pos1))
3775 (insert word2))))
3776 \f
3777 (defun backward-word (&optional arg)
3778 "Move backward until encountering the beginning of a word.
3779 With argument, do this that many times."
3780 (interactive "p")
3781 (forward-word (- (or arg 1))))
3783 (defun mark-word (&optional arg allow-extend)
3784 "Set mark ARG words away from point.
3786 move to with the same argument.
3787 Interactively, if this command is repeated
3788 or (in Transient Mark mode) if the mark is active,
3789 it marks the next ARG words after the ones already marked."
3791 (cond ((and allow-extend
3792 (or (and (eq last-command this-command) (mark t))
3793 (and transient-mark-mode mark-active)))
3794 (setq arg (if arg (prefix-numeric-value arg)
3795 (if (< (mark) (point)) -1 1)))
3796 (set-mark
3797 (save-excursion
3798 (goto-char (mark))
3799 (forward-word arg)
3800 (point))))
3801 (t
3802 (push-mark
3803 (save-excursion
3804 (forward-word (prefix-numeric-value arg))
3805 (point))
3806 nil t))))
3808 (defun kill-word (arg)
3809 "Kill characters forward until encountering the end of a word.
3810 With argument, do this that many times."
3811 (interactive "p")
3812 (kill-region (point) (progn (forward-word arg) (point))))
3814 (defun backward-kill-word (arg)
3815 "Kill characters backward until encountering the end of a word.
3816 With argument, do this that many times."
3817 (interactive "p")
3818 (kill-word (- arg)))
3820 (defun current-word (&optional strict really-word)
3821 "Return the symbol or word that point is on (or a nearby one) as a string.
3822 The return value includes no text properties.
3823 If optional arg STRICT is non-nil, return nil unless point is within
3824 or adjacent to a symbol or word. In all cases the value can be nil
3825 if there is no word nearby.
3826 The function, belying its name, normally finds a symbol.
3827 If optional arg REALLY-WORD is non-nil, it finds just a word."
3828 (save-excursion
3829 (let* ((oldpoint (point)) (start (point)) (end (point))
3830 (syntaxes (if really-word "w" "w_"))
3831 (not-syntaxes (concat "^" syntaxes)))
3832 (skip-syntax-backward syntaxes) (setq start (point))
3833 (goto-char oldpoint)
3834 (skip-syntax-forward syntaxes) (setq end (point))
3835 (when (and (eq start oldpoint) (eq end oldpoint)
3836 ;; Point is neither within nor adjacent to a word.
3837 (not strict))
3838 ;; Look for preceding word in same line.
3839 (skip-syntax-backward not-syntaxes
3840 (save-excursion (beginning-of-line)
3841 (point)))
3842 (if (bolp)
3843 ;; No preceding word in same line.
3844 ;; Look for following word in same line.
3845 (progn
3846 (skip-syntax-forward not-syntaxes
3847 (save-excursion (end-of-line)
3848 (point)))
3849 (setq start (point))
3850 (skip-syntax-forward syntaxes)
3851 (setq end (point)))
3852 (setq end (point))
3853 (skip-syntax-backward syntaxes)
3854 (setq start (point))))
3855 ;; If we found something nonempty, return it as a string.
3856 (unless (= start end)
3857 (buffer-substring-no-properties start end)))))
3858 \f
3859 (defcustom fill-prefix nil
3860 "*String for filling to insert at front of new line, or nil for none."
3861 :type '(choice (const :tag "None" nil)
3862 string)
3863 :group 'fill)
3864 (make-variable-buffer-local 'fill-prefix)
3866 (defcustom auto-fill-inhibit-regexp nil
3867 "*Regexp to match lines which should not be auto-filled."
3868 :type '(choice (const :tag "None" nil)
3869 regexp)
3870 :group 'fill)
3872 (defvar comment-line-break-function 'comment-indent-new-line
3873 "*Mode-specific function which line breaks and continues a comment.
3875 This function is only called during auto-filling of a comment section.
3876 The function should take a single optional argument, which is a flag
3877 indicating whether it should use soft newlines.
3879 Setting this variable automatically makes it local to the current buffer.")
3881 ;; This function is used as the auto-fill-function of a buffer
3882 ;; when Auto-Fill mode is enabled.
3883 ;; It returns t if it really did any work.
3884 ;; (Actually some major modes use a different auto-fill function,
3885 ;; but this one is the default one.)
3886 (defun do-auto-fill ()
3887 (let (fc justify give-up
3888 (fill-prefix fill-prefix))
3889 (if (or (not (setq justify (current-justification)))
3890 (null (setq fc (current-fill-column)))
3891 (and (eq justify 'left)
3892 (<= (current-column) fc))
3893 (and auto-fill-inhibit-regexp
3894 (save-excursion (beginning-of-line)
3895 (looking-at auto-fill-inhibit-regexp))))
3896 nil ;; Auto-filling not required
3897 (if (memq justify '(full center right))
3898 (save-excursion (unjustify-current-line)))
3900 ;; Choose a fill-prefix automatically.
3901 (when (and adaptive-fill-mode
3902 (or (null fill-prefix) (string= fill-prefix "")))
3903 (let ((prefix
3904 (fill-context-prefix
3905 (save-excursion (backward-paragraph 1) (point))
3906 (save-excursion (forward-paragraph 1) (point)))))
3907 (and prefix (not (equal prefix ""))
3908 ;; Use auto-indentation rather than a guessed empty prefix.
3909 (not (and fill-indent-according-to-mode
3911 (setq fill-prefix prefix))))
3913 (while (and (not give-up) (> (current-column) fc))
3914 ;; Determine where to split the line.
3915 (let* (after-prefix
3916 (fill-point
3917 (save-excursion
3918 (beginning-of-line)
3919 (setq after-prefix (point))
3920 (and fill-prefix
3921 (looking-at (regexp-quote fill-prefix))
3922 (setq after-prefix (match-end 0)))
3923 (move-to-column (1+ fc))
3924 (fill-move-to-break-point after-prefix)
3925 (point))))
3927 ;; See whether the place we found is any good.
3928 (if (save-excursion
3929 (goto-char fill-point)
3930 (or (bolp)
3931 ;; There is no use breaking at end of line.
3932 (save-excursion (skip-chars-forward " ") (eolp))
3933 ;; It is futile to split at the end of the prefix
3934 ;; since we would just insert the prefix again.
3935 (and after-prefix (<= (point) after-prefix))
3936 ;; Don't split right after a comment starter
3937 ;; since we would just make another comment starter.
3938 (and comment-start-skip
3939 (let ((limit (point)))
3940 (beginning-of-line)
3941 (and (re-search-forward comment-start-skip
3942 limit t)
3943 (eq (point) limit))))))
3944 ;; No good place to break => stop trying.
3945 (setq give-up t)
3946 ;; Ok, we have a useful place to break the line. Do it.
3947 (let ((prev-column (current-column)))
3948 ;; If point is at the fill-point, do not `save-excursion'.
3949 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
3950 ;; point will end up before it rather than after it.
3951 (if (save-excursion
3953 (= (point) fill-point))
3954 (funcall comment-line-break-function t)
3955 (save-excursion
3956 (goto-char fill-point)
3957 (funcall comment-line-break-function t)))
3958 ;; Now do justification, if required
3959 (if (not (eq justify 'left))
3960 (save-excursion
3961 (end-of-line 0)
3962 (justify-current-line justify nil t)))
3963 ;; If making the new line didn't reduce the hpos of
3964 ;; the end of the line, then give up now;
3965 ;; trying again will not help.
3966 (if (>= (current-column) prev-column)
3967 (setq give-up t))))))
3968 ;; Justify last line.
3969 (justify-current-line justify t t)
3970 t)))
3972 (defvar normal-auto-fill-function 'do-auto-fill
3973 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
3974 Some major modes set this.")
3976 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
3977 ;; FIXME: turn into a proper minor mode.
3978 ;; Add a global minor mode version of it.
3979 (defun auto-fill-mode (&optional arg)
3980 "Toggle Auto Fill mode.
3981 With arg, turn Auto Fill mode on if and only if arg is positive.
3982 In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
3983 automatically breaks the line at a previous space.
3985 The value of `normal-auto-fill-function' specifies the function to use
3986 for `auto-fill-function' when turning Auto Fill mode on."
3987 (interactive "P")
3988 (prog1 (setq auto-fill-function
3989 (if (if (null arg)
3990 (not auto-fill-function)
3991 (> (prefix-numeric-value arg) 0))
3992 normal-auto-fill-function
3993 nil))
3994 (force-mode-line-update)))
3996 ;; This holds a document string used to document auto-fill-mode.
3997 (defun auto-fill-function ()
3998 "Automatically break line at a previous space, in insertion of text."
3999 nil)
4001 (defun turn-on-auto-fill ()
4002 "Unconditionally turn on Auto Fill mode."
4003 (auto-fill-mode 1))
4005 (defun turn-off-auto-fill ()
4006 "Unconditionally turn off Auto Fill mode."
4007 (auto-fill-mode -1))
4009 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
4011 (defun set-fill-column (arg)
4012 "Set `fill-column' to specified argument.
4015 (interactive "P")
4016 (if (consp arg)
4017 (setq arg (current-column)))
4018 (if (not (integerp arg))
4019 ;; Disallow missing argument; it's probably a typo for C-x C-f.
4020 (error "Set-fill-column requires an explicit argument")
4021 (message "Fill column set to %d (was %d)" arg fill-column)
4022 (setq fill-column arg)))
4023 \f
4024 (defun set-selective-display (arg)
4025 "Set `selective-display' to ARG; clear it if no arg.
4026 When the value of `selective-display' is a number > 0,
4027 lines whose indentation is >= that value are not displayed.
4028 The variable `selective-display' has a separate value for each buffer."
4029 (interactive "P")
4030 (if (eq selective-display t)
4031 (error "selective-display already in use for marked lines"))
4032 (let ((current-vpos
4033 (save-restriction
4034 (narrow-to-region (point-min) (point))
4035 (goto-char (window-start))
4036 (vertical-motion (window-height)))))
4037 (setq selective-display
4038 (and arg (prefix-numeric-value arg)))
4039 (recenter current-vpos))
4040 (set-window-start (selected-window) (window-start (selected-window)))
4041 (princ "selective-display set to " t)
4042 (prin1 selective-display t)
4043 (princ "." t))
4045 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
4046 (defvaralias 'default-indicate-unused-lines 'default-indicate-empty-lines)
4048 (defun toggle-truncate-lines (arg)
4049 "Toggle whether to fold or truncate long lines on the screen.
4050 With arg, truncate long lines iff arg is positive.
4051 Note that in side-by-side windows, truncation is always enabled."
4052 (interactive "P")
4053 (setq truncate-lines
4054 (if (null arg)
4055 (not truncate-lines)
4056 (> (prefix-numeric-value arg) 0)))
4057 (force-mode-line-update)
4058 (unless truncate-lines
4059 (let ((buffer (current-buffer)))
4060 (walk-windows (lambda (window)
4061 (if (eq buffer (window-buffer window))
4062 (set-window-hscroll window 0)))
4063 nil t)))
4064 (message "Truncate long lines %s"
4065 (if truncate-lines "enabled" "disabled")))
4067 (defvar overwrite-mode-textual " Ovwrt"
4068 "The string displayed in the mode line when in overwrite mode.")
4069 (defvar overwrite-mode-binary " Bin Ovwrt"
4070 "The string displayed in the mode line when in binary overwrite mode.")
4072 (defun overwrite-mode (arg)
4073 "Toggle overwrite mode.
4074 With arg, turn overwrite mode on iff arg is positive.
4075 In overwrite mode, printing characters typed in replace existing text
4076 on a one-for-one basis, rather than pushing it to the right. At the
4077 end of a line, such characters extend the line. Before a tab,
4078 such characters insert until the tab is filled in.
4080 is supposed to make it easier to insert characters when necessary."
4081 (interactive "P")
4082 (setq overwrite-mode
4083 (if (if (null arg) (not overwrite-mode)
4084 (> (prefix-numeric-value arg) 0))
4085 'overwrite-mode-textual))
4086 (force-mode-line-update))
4088 (defun binary-overwrite-mode (arg)
4089 "Toggle binary overwrite mode.
4090 With arg, turn binary overwrite mode on iff arg is positive.
4091 In binary overwrite mode, printing characters typed in replace
4092 existing text. Newlines are not treated specially, so typing at the
4093 end of a line joins the line to the next, with the typed character
4094 between them. Typing before a tab character simply replaces the tab
4095 with the character typed.
4097 typing characters do.
4099 Note that binary overwrite mode is not its own minor mode; it is a
4100 specialization of overwrite-mode, entered by setting the
4101 `overwrite-mode' variable to `overwrite-mode-binary'."
4102 (interactive "P")
4103 (setq overwrite-mode
4104 (if (if (null arg)
4105 (not (eq overwrite-mode 'overwrite-mode-binary))
4106 (> (prefix-numeric-value arg) 0))
4107 'overwrite-mode-binary))
4108 (force-mode-line-update))
4110 (define-minor-mode line-number-mode
4111 "Toggle Line Number mode.
4112 With arg, turn Line Number mode on iff arg is positive.
4113 When Line Number mode is enabled, the line number appears
4114 in the mode line.
4116 Line numbers do not appear for very large buffers and buffers
4117 with very long lines; see variables `line-number-display-limit'
4118 and `line-number-display-limit-width'."
4119 :init-value t :global t :group 'editing-basics :require nil)
4121 (define-minor-mode column-number-mode
4122 "Toggle Column Number mode.
4123 With arg, turn Column Number mode on iff arg is positive.
4124 When Column Number mode is enabled, the column number appears
4125 in the mode line."
4126 :global t :group 'editing-basics :require nil)
4128 (define-minor-mode size-indication-mode
4129 "Toggle Size Indication mode.
4130 With arg, turn Size Indication mode on iff arg is positive. When
4131 Size Indication mode is enabled, the size of the accessible part
4132 of the buffer appears in the mode line."
4133 :global t :group 'editing-basics :require nil)
4134 \f
4135 (defgroup paren-blinking nil
4136 "Blinking matching of parens and expressions."
4137 :prefix "blink-matching-"
4138 :group 'paren-matching)
4140 (defcustom blink-matching-paren t
4141 "*Non-nil means show matching open-paren when close-paren is inserted."
4142 :type 'boolean
4143 :group 'paren-blinking)
4145 (defcustom blink-matching-paren-on-screen t
4146 "*Non-nil means show matching open-paren when it is on screen.
4147 If nil, means don't show it (but the open-paren can still be shown
4148 when it is off screen)."
4149 :type 'boolean
4150 :group 'paren-blinking)
4152 (defcustom blink-matching-paren-distance (* 25 1024)
4153 "*If non-nil, is maximum distance to search for matching open-paren."
4154 :type 'integer
4155 :group 'paren-blinking)
4157 (defcustom blink-matching-delay 1
4158 "*Time in seconds to delay after showing a matching paren."
4159 :type 'number
4160 :group 'paren-blinking)
4162 (defcustom blink-matching-paren-dont-ignore-comments nil
4163 "*Non-nil means `blink-matching-paren' will not ignore comments."
4164 :type 'boolean
4165 :group 'paren-blinking)
4167 (defun blink-matching-open ()
4168 "Move cursor momentarily to the beginning of the sexp before point."
4169 (interactive)
4170 (and (> (point) (1+ (point-min)))
4171 blink-matching-paren
4172 ;; Verify an even number of quoting characters precede the close.
4173 (= 1 (logand 1 (- (point)
4174 (save-excursion
4175 (forward-char -1)
4177 (point)))))
4178 (let* ((oldpos (point))
4179 (blinkpos)
4180 (mismatch)
4181 matching-paren)
4182 (save-excursion
4183 (save-restriction
4184 (if blink-matching-paren-distance
4185 (narrow-to-region (max (point-min)
4186 (- (point) blink-matching-paren-distance))
4187 oldpos))
4188 (condition-case ()
4189 (let ((parse-sexp-ignore-comments
4190 (and parse-sexp-ignore-comments
4191 (not blink-matching-paren-dont-ignore-comments))))
4192 (setq blinkpos (scan-sexps oldpos -1)))
4193 (error nil)))
4194 (and blinkpos
4195 (not (eq (car (syntax-after blinkpos)) 8)) ;Not syntax '$'.
4196 (setq matching-paren
4197 (let ((syntax (syntax-after blinkpos)))
4198 (and (consp syntax)
4199 (eq (logand (car syntax) 255) 4)
4200 (cdr syntax)))
4201 mismatch
4202 (or (null matching-paren)
4203 (/= (char-after (1- oldpos))
4204 matching-paren))))
4205 (if mismatch (setq blinkpos nil))
4206 (if blinkpos
4207 ;; Don't log messages about paren matching.
4208 (let (message-log-max)
4209 (goto-char blinkpos)
4210 (if (pos-visible-in-window-p)
4211 (and blink-matching-paren-on-screen
4212 (sit-for blink-matching-delay))
4213 (goto-char blinkpos)
4214 (message
4215 "Matches %s"
4216 ;; Show what precedes the open in its line, if anything.
4217 (if (save-excursion
4219 (not (bolp)))
4220 (buffer-substring (progn (beginning-of-line) (point))
4221 (1+ blinkpos))
4222 ;; Show what follows the open in its line, if anything.
4223 (if (save-excursion
4224 (forward-char 1)
4226 (not (eolp)))
4227 (buffer-substring blinkpos
4228 (progn (end-of-line) (point)))
4229 ;; Otherwise show the previous nonblank line,
4230 ;; if there is one.
4231 (if (save-excursion
4233 (not (bobp)))
4234 (concat
4235 (buffer-substring (progn
4237 (beginning-of-line)
4238 (point))
4239 (progn (end-of-line)
4241 (point)))
4242 ;; Replace the newline and other whitespace with `...'.
4243 "..."
4244 (buffer-substring blinkpos (1+ blinkpos)))
4245 ;; There is nothing to show except the char itself.
4246 (buffer-substring blinkpos (1+ blinkpos))))))))
4247 (cond (mismatch
4248 (message "Mismatched parentheses"))
4249 ((not blink-matching-paren-distance)
4250 (message "Unmatched parenthesis"))))))))
4252 ;Turned off because it makes dbx bomb out.
4253 (setq blink-paren-function 'blink-matching-open)
4254 \f
4255 ;; This executes C-g typed while Emacs is waiting for a command.
4256 ;; Quitting out of a program does not go through here;
4257 ;; that happens in the QUIT macro at the C code level.
4258 (defun keyboard-quit ()
4259 "Signal a `quit' condition.
4260 During execution of Lisp code, this character causes a quit directly.
4261 At top-level, as an editor command, this simply beeps."
4262 (interactive)
4263 (deactivate-mark)
4264 (if (fboundp 'kmacro-keyboard-quit)
4265 (kmacro-keyboard-quit))
4266 (setq defining-kbd-macro nil)
4267 (signal 'quit nil))
4269 (define-key global-map "\C-g" 'keyboard-quit)
4271 (defvar buffer-quit-function nil
4274 \(such as cancelling a prefix argument, minibuffer or region) do not apply.")
4276 (defun keyboard-escape-quit ()
4278 This command can exit an interactive command such as `query-replace',
4279 can clear out a prefix argument or a region,
4280 can get out of the minibuffer or other recursive edit,
4281 cancel the use of the current buffer (for special-purpose buffers),
4282 or go back to just one window (by deleting all but the selected window)."
4283 (interactive)
4284 (cond ((eq last-command 'mode-exited) nil)
4285 ((> (minibuffer-depth) 0)
4286 (abort-recursive-edit))
4287 (current-prefix-arg
4288 nil)
4289 ((and transient-mark-mode mark-active)
4290 (deactivate-mark))
4291 ((> (recursion-depth) 0)
4292 (exit-recursive-edit))
4293 (buffer-quit-function
4294 (funcall buffer-quit-function))
4295 ((not (one-window-p t))
4296 (delete-other-windows))
4298 (bury-buffer))))
4300 (defun play-sound-file (file &optional volume device)
4301 "Play sound stored in FILE.
4302 VOLUME and DEVICE correspond to the keywords of the sound
4303 specification for `play-sound'."
4304 (interactive "fPlay sound file: ")
4305 (let ((sound (list :file file)))
4306 (if volume
4307 (plist-put sound :volume volume))
4308 (if device
4309 (plist-put sound :device device))
4310 (push 'sound sound)
4311 (play-sound sound)))
4313 (define-key global-map "\e\e\e" 'keyboard-escape-quit)
4314 \f
4315 (defcustom read-mail-command 'rmail
4316 "*Your preference for a mail reading package.
4317 This is used by some keybindings which support reading mail.
4318 See also `mail-user-agent' concerning sending mail."
4319 :type '(choice (function-item rmail)
4320 (function-item gnus)
4321 (function-item mh-rmail)
4322 (function :tag "Other"))
4323 :version "21.1"
4324 :group 'mail)
4326 (defcustom mail-user-agent 'sendmail-user-agent
4327 "*Your preference for a mail composition package.
4328 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
4329 outgoing email message. This variable lets you specify which
4330 mail-sending package you prefer.
4332 Valid values include:
4334 `sendmail-user-agent' -- use the default Emacs Mail package.
4335 See Info node `(emacs)Sending Mail'.
4336 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
4337 See Info node `(mh-e)'.
4338 `message-user-agent' -- use the Gnus Message package.
4339 See Info node `(message)'.
4340 `gnus-user-agent' -- like `message-user-agent', but with Gnus
4341 paraphernalia, particularly the Gcc: header for
4342 archiving.
4344 Additional valid symbols may be available; check with the author of
4345 your package for details. The function should return non-nil if it
4346 succeeds.
4348 See also `read-mail-command' concerning reading mail."
4349 :type '(radio (function-item :tag "Default Emacs mail"
4351 sendmail-user-agent)
4352 (function-item :tag "Emacs interface to MH"
4354 mh-e-user-agent)
4355 (function-item :tag "Gnus Message package"
4357 message-user-agent)
4358 (function-item :tag "Gnus Message with full Gnus features"
4360 gnus-user-agent)
4361 (function :tag "Other"))
4362 :group 'mail)
4364 (define-mail-user-agent 'sendmail-user-agent
4365 'sendmail-user-agent-compose
4366 'mail-send-and-exit)
4368 (defun rfc822-goto-eoh ()
4369 ;; Go to header delimiter line in a mail message, following RFC822 rules
4370 (goto-char (point-min))
4371 (when (re-search-forward
4373 (goto-char (match-beginning 0))))
4375 (defun sendmail-user-agent-compose (&optional to subject other-headers continue
4376 switch-function yank-action
4377 send-actions)
4378 (if switch-function
4379 (let ((special-display-buffer-names nil)
4380 (special-display-regexps nil)
4381 (same-window-buffer-names nil)
4382 (same-window-regexps nil))
4383 (funcall switch-function "*mail*")))
4384 (let ((cc (cdr (assoc-string "cc" other-headers t)))
4385 (in-reply-to (cdr (assoc-string "in-reply-to" other-headers t)))
4386 (body (cdr (assoc-string "body" other-headers t))))
4387 (or (mail continue to subject in-reply-to cc yank-action send-actions)
4388 continue
4389 (error "Message aborted"))
4390 (save-excursion
4391 (rfc822-goto-eoh)
4392 (while other-headers
4393 (unless (member-ignore-case (car (car other-headers))
4394 '("in-reply-to" "cc" "body"))
4395 (insert (car (car other-headers)) ": "
4397 (setq other-headers (cdr other-headers)))
4398 (when body
4399 (forward-line 1)
4400 (insert body))
4401 t)))
4403 (define-mail-user-agent 'mh-e-user-agent
4404 'mh-smail-batch 'mh-send-letter 'mh-fully-kill-draft
4405 'mh-before-send-letter-hook)
4407 (defun compose-mail (&optional to subject other-headers continue
4408 switch-function yank-action send-actions)
4409 "Start composing a mail message to send.
4410 This uses the user's chosen mail composition package
4411 as selected with the variable `mail-user-agent'.
4412 The optional arguments TO and SUBJECT specify recipients
4413 and the initial Subject field, respectively.
4415 OTHER-HEADERS is an alist specifying additional
4416 header fields. Elements look like (HEADER . VALUE) where both
4417 HEADER and VALUE are strings.
4419 CONTINUE, if non-nil, says to continue editing a message already
4420 being composed.
4422 SWITCH-FUNCTION, if non-nil, is a function to use to
4423 switch to and display the buffer used for mail composition.
4425 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
4426 to insert the raw text of the message being replied to.
4427 It has the form (FUNCTION . ARGS). The user agent will apply
4428 FUNCTION to ARGS, to insert the raw text of the original message.
4429 \(The user agent will also run `mail-citation-hook', *after* the
4430 original text has been inserted in this way.)
4432 SEND-ACTIONS is a list of actions to call when the message is sent.
4433 Each action has the form (FUNCTION . ARGS)."
4434 (interactive
4435 (list nil nil nil current-prefix-arg))
4436 (let ((function (get mail-user-agent 'composefunc)))
4437 (funcall function to subject other-headers continue
4438 switch-function yank-action send-actions)))
4440 (defun compose-mail-other-window (&optional to subject other-headers continue
4441 yank-action send-actions)
4443 (interactive
4444 (list nil nil nil current-prefix-arg))
4445 (compose-mail to subject other-headers continue
4446 'switch-to-buffer-other-window yank-action send-actions))
4449 (defun compose-mail-other-frame (&optional to subject other-headers continue
4450 yank-action send-actions)
4452 (interactive
4453 (list nil nil nil current-prefix-arg))
4454 (compose-mail to subject other-headers continue
4455 'switch-to-buffer-other-frame yank-action send-actions))
4456 \f
4457 (defvar set-variable-value-history nil
4458 "History of values entered with `set-variable'.")
4460 (defun set-variable (var val &optional make-local)
4461 "Set VARIABLE to VALUE. VALUE is a Lisp object.
4462 When using this interactively, enter a Lisp object for VALUE.
4463 If you want VALUE to be a string, you must surround it with doublequotes.
4464 VALUE is used literally, not evaluated.
4466 If VARIABLE has a `variable-interactive' property, that is used as if
4467 it were the arg to `interactive' (which see) to interactively read VALUE.
4469 If VARIABLE has been defined with `defcustom', then the type information
4470 in the definition is used to check that VALUE is valid.
4472 With a prefix argument, set VARIABLE to VALUE buffer-locally."
4473 (interactive
4474 (let* ((default-var (variable-at-point))
4475 (var (if (symbolp default-var)
4476 (read-variable (format "Set variable (default %s): " default-var)
4477 default-var)
4478 (read-variable "Set variable: ")))
4479 (minibuffer-help-form '(describe-variable var))
4480 (prop (get var 'variable-interactive))
4481 (prompt (format "Set %s%s to value: " var
4482 (cond ((local-variable-p var)
4483 " (buffer-local)")
4484 ((or current-prefix-arg
4485 (local-variable-if-set-p var))
4486 " buffer-locally")
4487 (t " globally"))))
4488 (val (if prop
4489 ;; Use VAR's `variable-interactive' property
4490 ;; as an interactive spec for prompting.
4491 (call-interactively `(lambda (arg)
4492 (interactive ,prop)
4493 arg))
4494 (read
4495 (read-string prompt nil
4496 'set-variable-value-history)))))
4497 (list var val current-prefix-arg)))
4499 (and (custom-variable-p var)
4500 (not (get var 'custom-type))
4501 (custom-load-symbol var))
4502 (let ((type (get var 'custom-type)))
4503 (when type
4504 ;; Match with custom type.
4505 (require 'cus-edit)
4506 (setq type (widget-convert type))
4507 (unless (widget-apply type :match val)
4508 (error "Value `%S' does not match type %S of %S"
4509 val (car type) var))))
4511 (if make-local
4512 (make-local-variable var))
4514 (set var val)
4516 ;; Force a thorough redisplay for the case that the variable
4517 ;; has an effect on the display, like `tab-width' has.
4518 (force-mode-line-update))
4519 \f
4520 ;; Define the major mode for lists of completions.
4522 (defvar completion-list-mode-map nil
4523 "Local map for completion list buffers.")
4524 (or completion-list-mode-map
4525 (let ((map (make-sparse-keymap)))
4526 (define-key map [mouse-2] 'mouse-choose-completion)
4527 (define-key map [follow-link] 'mouse-face)
4528 (define-key map [down-mouse-2] nil)
4529 (define-key map "\C-m" 'choose-completion)
4530 (define-key map "\e\e\e" 'delete-completion-window)
4531 (define-key map [left] 'previous-completion)
4532 (define-key map [right] 'next-completion)
4533 (setq completion-list-mode-map map)))
4535 ;; Completion mode is suitable only for specially formatted data.
4536 (put 'completion-list-mode 'mode-class 'special)
4538 (defvar completion-reference-buffer nil
4539 "Record the buffer that was current when the completion list was requested.
4540 This is a local variable in the completion list buffer.
4541 Initial value is nil to avoid some compiler warnings.")
4543 (defvar completion-no-auto-exit nil
4544 "Non-nil means `choose-completion-string' should never exit the minibuffer.
4545 This also applies to other functions such as `choose-completion'
4546 and `mouse-choose-completion'.")
4548 (defvar completion-base-size nil
4549 "Number of chars at beginning of minibuffer not involved in completion.
4550 This is a local variable in the completion list buffer
4551 but it talks about the buffer in `completion-reference-buffer'.
4552 If this is nil, it means to compare text to determine which part
4553 of the tail end of the buffer's text is involved in completion.")
4555 (defun delete-completion-window ()
4556 "Delete the completion list window.
4557 Go to the window from which completion was requested."
4558 (interactive)
4559 (let ((buf completion-reference-buffer))
4560 (if (one-window-p t)
4561 (if (window-dedicated-p (selected-window))
4562 (delete-frame (selected-frame)))
4563 (delete-window (selected-window))
4564 (if (get-buffer-window buf)
4565 (select-window (get-buffer-window buf))))))
4567 (defun previous-completion (n)
4568 "Move to the previous item in the completion list."
4569 (interactive "p")
4570 (next-completion (- n)))
4572 (defun next-completion (n)
4573 "Move to the next item in the completion list.
4574 With prefix argument N, move N items (negative N means move backward)."
4575 (interactive "p")
4576 (let ((beg (point-min)) (end (point-max)))
4577 (while (and (> n 0) (not (eobp)))
4578 ;; If in a completion, move to the end of it.
4579 (when (get-text-property (point) 'mouse-face)
4580 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
4581 ;; Move to start of next one.
4582 (unless (get-text-property (point) 'mouse-face)
4583 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
4584 (setq n (1- n)))
4585 (while (and (< n 0) (not (bobp)))
4586 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
4587 ;; If in a completion, move to the start of it.
4588 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
4589 (goto-char (previous-single-property-change
4590 (point) 'mouse-face nil beg)))
4591 ;; Move to end of the previous completion.
4592 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
4593 (goto-char (previous-single-property-change
4594 (point) 'mouse-face nil beg)))
4595 ;; Move to the start of that one.
4596 (goto-char (previous-single-property-change
4597 (point) 'mouse-face nil beg))
4598 (setq n (1+ n))))))
4600 (defun choose-completion ()
4601 "Choose the completion that point is in or next to."
4602 (interactive)
4603 (let (beg end completion (buffer completion-reference-buffer)
4604 (base-size completion-base-size))
4605 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
4606 (setq end (point) beg (1+ (point))))
4607 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
4608 (setq end (1- (point)) beg (point)))
4609 (if (null beg)
4610 (error "No completion here"))
4611 (setq beg (previous-single-property-change beg 'mouse-face))
4612 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
4613 (setq completion (buffer-substring beg end))
4614 (let ((owindow (selected-window)))
4615 (if (and (one-window-p t 'selected-frame)
4616 (window-dedicated-p (selected-window)))
4617 ;; This is a special buffer's frame
4618 (iconify-frame (selected-frame))
4619 (or (window-dedicated-p (selected-window))
4620 (bury-buffer)))
4621 (select-window owindow))
4622 (choose-completion-string completion buffer base-size)))
4624 ;; Delete the longest partial match for STRING
4625 ;; that can be found before POINT.
4626 (defun choose-completion-delete-max-match (string)
4627 (let ((opoint (point))
4628 len)
4629 ;; Try moving back by the length of the string.
4630 (goto-char (max (- (point) (length string))
4631 (minibuffer-prompt-end)))
4632 ;; See how far back we were actually able to move. That is the
4633 ;; upper bound on how much we can match and delete.
4634 (setq len (- opoint (point)))
4635 (if completion-ignore-case
4636 (setq string (downcase string)))
4637 (while (and (> len 0)
4638 (let ((tail (buffer-substring (point) opoint)))
4639 (if completion-ignore-case
4640 (setq tail (downcase tail)))
4641 (not (string= tail (substring string 0 len)))))
4642 (setq len (1- len))
4643 (forward-char 1))
4644 (delete-char len)))
4646 (defvar choose-completion-string-functions nil
4647 "Functions that may override the normal insertion of a completion choice.
4648 These functions are called in order with four arguments:
4649 CHOICE - the string to insert in the buffer,
4650 BUFFER - the buffer in which the choice should be inserted,
4651 MINI-P - non-nil iff BUFFER is a minibuffer, and
4652 BASE-SIZE - the number of characters in BUFFER before
4653 the string being completed.
4655 If a function in the list returns non-nil, that function is supposed
4656 to have inserted the CHOICE in the BUFFER, and possibly exited
4657 the minibuffer; no further functions will be called.
4659 If all functions in the list return nil, that means to use
4660 the default method of inserting the completion in BUFFER.")
4662 (defun choose-completion-string (choice &optional buffer base-size)
4663 "Switch to BUFFER and insert the completion choice CHOICE.
4664 BASE-SIZE, if non-nil, says how many characters of BUFFER's text
4665 to keep. If it is nil, we call `choose-completion-delete-max-match'
4666 to decide what to delete."
4668 ;; If BUFFER is the minibuffer, exit the minibuffer
4669 ;; unless it is reading a file name and CHOICE is a directory,
4670 ;; or completion-no-auto-exit is non-nil.
4672 (let* ((buffer (or buffer completion-reference-buffer))
4673 (mini-p (minibufferp buffer)))
4674 ;; If BUFFER is a minibuffer, barf unless it's the currently
4675 ;; active minibuffer.
4676 (if (and mini-p
4677 (or (not (active-minibuffer-window))
4678 (not (equal buffer
4679 (window-buffer (active-minibuffer-window))))))
4680 (error "Minibuffer is not active for completion")
4681 ;; Set buffer so buffer-local choose-completion-string-functions works.
4682 (set-buffer buffer)
4683 (unless (run-hook-with-args-until-success
4684 'choose-completion-string-functions
4685 choice buffer mini-p base-size)
4686 ;; Insert the completion into the buffer where it was requested.
4687 (if base-size
4688 (delete-region (+ base-size (if mini-p
4689 (minibuffer-prompt-end)
4690 (point-min)))
4691 (point))
4692 (choose-completion-delete-max-match choice))
4693 (insert choice)
4694 (remove-text-properties (- (point) (length choice)) (point)
4695 '(mouse-face nil))
4696 ;; Update point in the window that BUFFER is showing in.
4697 (let ((window (get-buffer-window buffer t)))
4698 (set-window-point window (point)))
4699 ;; If completing for the minibuffer, exit it with this choice.
4700 (and (not completion-no-auto-exit)
4701 (equal buffer (window-buffer (minibuffer-window)))
4702 minibuffer-completion-table
4703 ;; If this is reading a file name, and the file name chosen
4704 ;; is a directory, don't exit the minibuffer.
4705 (if (and (eq minibuffer-completion-table 'read-file-name-internal)
4706 (file-directory-p (field-string (point-max))))
4707 (let ((mini (active-minibuffer-window)))
4708 (select-window mini)
4709 (when minibuffer-auto-raise
4710 (raise-frame (window-frame mini))))
4711 (exit-minibuffer)))))))
4713 (defun completion-list-mode ()
4714 "Major mode for buffers showing lists of possible completions.
4716 to select the completion near point.
4718 with the mouse."
4719 (interactive)
4720 (kill-all-local-variables)
4721 (use-local-map completion-list-mode-map)
4722 (setq mode-name "Completion List")
4723 (setq major-mode 'completion-list-mode)
4724 (make-local-variable 'completion-base-size)
4725 (setq completion-base-size nil)
4726 (run-hooks 'completion-list-mode-hook))
4728 (defun completion-list-mode-finish ()
4729 "Finish setup of the completions buffer.
4730 Called from `temp-buffer-show-hook'."
4731 (when (eq major-mode 'completion-list-mode)
4732 (toggle-read-only 1)))
4734 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
4736 (defvar completion-setup-hook nil
4737 "Normal hook run at the end of setting up a completion list buffer.
4738 When this hook is run, the current buffer is the one in which the
4739 command to display the completion list buffer was run.
4740 The completion list buffer is available as the value of `standard-output'.")
4742 ;; This function goes in completion-setup-hook, so that it is called
4743 ;; after the text of the completion list buffer is written.
4744 (defface completions-first-difference
4745 '((t (:inherit bold)))
4746 "Face put on the first uncommon character in completions in *Completions* buffer."
4747 :group 'completion)
4749 (defface completions-common-part
4750 '((t (:inherit default)))
4751 "Face put on the common prefix substring in completions in *Completions* buffer.
4752 The idea of `completions-common-part' is that you can use it to
4753 make the common parts less visible than normal, so that the rest
4754 of the differing parts is, by contrast, slightly highlighted."
4755 :group 'completion)
4757 ;; This is for packages that need to bind it to a non-default regexp
4758 ;; in order to make the first-differing character highlight work
4759 ;; to their liking
4760 (defvar completion-root-regexp "^/"
4761 "Regexp to use in `completion-setup-function' to find the root directory.")
4763 (defun completion-setup-function ()
4764 (let ((mainbuf (current-buffer))
4765 (mbuf-contents (minibuffer-contents)))
4766 ;; When reading a file name in the minibuffer,
4767 ;; set default-directory in the minibuffer
4768 ;; so it will get copied into the completion list buffer.
4769 (if minibuffer-completing-file-name
4770 (with-current-buffer mainbuf
4771 (setq default-directory (file-name-directory mbuf-contents))))
4772 ;; If partial-completion-mode is on, point might not be after the
4773 ;; last character in the minibuffer.
4774 ;; FIXME: This still doesn't work if the text to be completed
4775 ;; starts with a `-'.
4776 (when (and partial-completion-mode (not (eobp)))
4777 (setq mbuf-contents
4778 (substring mbuf-contents 0 (- (point) (point-max)))))
4779 (with-current-buffer standard-output
4780 (completion-list-mode)
4781 (make-local-variable 'completion-reference-buffer)
4782 (setq completion-reference-buffer mainbuf)
4783 (if minibuffer-completing-file-name
4784 ;; For file name completion,
4785 ;; use the number of chars before the start of the
4786 ;; last file name component.
4787 (setq completion-base-size
4788 (with-current-buffer mainbuf
4789 (save-excursion
4790 (goto-char (point-max))
4791 (skip-chars-backward completion-root-regexp)
4792 (- (point) (minibuffer-prompt-end)))))
4793 ;; Otherwise, in minibuffer, the whole input is being completed.
4794 (if (minibufferp mainbuf)
4795 (setq completion-base-size 0)))
4796 ;; Put faces on first uncommon characters and common parts.
4797 (when completion-base-size
4798 (let* ((common-string-length
4799 (- (length mbuf-contents) completion-base-size))
4800 (element-start (next-single-property-change
4801 (point-min)
4802 'mouse-face))
4803 (element-common-end
4804 (and element-start
4805 (+ (or element-start nil) common-string-length)))
4806 (maxp (point-max)))
4807 (while (and element-start (< element-common-end maxp))
4808 (when (and (get-char-property element-start 'mouse-face)
4809 (get-char-property element-common-end 'mouse-face))
4810 (put-text-property element-start element-common-end
4811 'font-lock-face 'completions-common-part)
4812 (put-text-property element-common-end (1+ element-common-end)
4813 'font-lock-face 'completions-first-difference))
4814 (setq element-start (next-single-property-change
4815 element-start
4816 'mouse-face))
4817 (if element-start
4818 (setq element-common-end (+ element-start common-string-length))))))
4819 ;; Insert help string.
4820 (goto-char (point-min))
4821 (if (display-mouse-p)
4822 (insert (substitute-command-keys
4824 (insert (substitute-command-keys
4828 (add-hook 'completion-setup-hook 'completion-setup-function)
4830 (define-key minibuffer-local-completion-map [prior]
4831 'switch-to-completions)
4832 (define-key minibuffer-local-must-match-map [prior]
4833 'switch-to-completions)
4834 (define-key minibuffer-local-completion-map "\M-v"
4835 'switch-to-completions)
4836 (define-key minibuffer-local-must-match-map "\M-v"
4837 'switch-to-completions)
4839 (defun switch-to-completions ()
4840 "Select the completion list window."
4841 (interactive)
4842 ;; Make sure we have a completions window.
4843 (or (get-buffer-window "*Completions*")
4844 (minibuffer-completion-help))
4845 (let ((window (get-buffer-window "*Completions*")))
4846 (when window
4847 (select-window window)
4848 (goto-char (point-min))
4850 (forward-line 1))))
4852 ;; Support keyboard commands to turn on various modifiers.
4854 ;; These functions -- which are not commands -- each add one modifier
4855 ;; to the following event.
4857 (defun event-apply-alt-modifier (ignore-prompt)
4860 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
4861 (defun event-apply-super-modifier (ignore-prompt)
4864 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
4865 (defun event-apply-hyper-modifier (ignore-prompt)
4868 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
4869 (defun event-apply-shift-modifier (ignore-prompt)
4872 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
4873 (defun event-apply-control-modifier (ignore-prompt)
4876 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
4877 (defun event-apply-meta-modifier (ignore-prompt)
4880 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
4882 (defun event-apply-modifier (event symbol lshiftby prefix)
4883 "Apply a modifier flag to event EVENT.
4884 SYMBOL is the name of this modifier, as a symbol.
4885 LSHIFTBY is the numeric value of this modifier, in keyboard events.
4886 PREFIX is the string that represents this modifier in an event type symbol."
4887 (if (numberp event)
4888 (cond ((eq symbol 'control)
4889 (if (and (<= (downcase event) ?z)
4890 (>= (downcase event) ?a))
4891 (- (downcase event) ?a -1)
4892 (if (and (<= (downcase event) ?Z)
4893 (>= (downcase event) ?A))
4894 (- (downcase event) ?A -1)
4895 (logior (lsh 1 lshiftby) event))))
4896 ((eq symbol 'shift)
4897 (if (and (<= (downcase event) ?z)
4898 (>= (downcase event) ?a))
4899 (upcase event)
4900 (logior (lsh 1 lshiftby) event)))
4901 (t
4902 (logior (lsh 1 lshiftby) event)))
4903 (if (memq symbol (event-modifiers event))
4904 event
4905 (let ((event-type (if (symbolp event) event (car event))))
4906 (setq event-type (intern (concat prefix (symbol-name event-type))))
4907 (if (symbolp event)
4908 event-type
4909 (cons event-type (cdr event)))))))
4911 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
4912 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
4913 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
4914 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
4915 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
4916 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
4918 ;;;; Keypad support.
4920 ;;; Make the keypad keys act like ordinary typing keys. If people add
4921 ;;; bindings for the function key symbols, then those bindings will
4922 ;;; override these, so this shouldn't interfere with any existing
4923 ;;; bindings.
4925 ;; Also tell read-char how to handle these keys.
4926 (mapc
4927 (lambda (keypad-normal)
4928 (let ((keypad (nth 0 keypad-normal))
4929 (normal (nth 1 keypad-normal)))
4930 (put keypad 'ascii-character normal)
4931 (define-key function-key-map (vector keypad) (vector normal))))
4932 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
4933 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
4934 (kp-space ?\ )
4937 (kp-multiply ?*)
4938 (kp-add ?+)
4939 (kp-separator ?,)
4940 (kp-subtract ?-)
4941 (kp-decimal ?.)
4942 (kp-divide ?/)
4943 (kp-equal ?=)))
4944 \f
4945 ;;;;
4946 ;;;; forking a twin copy of a buffer.
4947 ;;;;
4949 (defvar clone-buffer-hook nil
4950 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
4952 (defun clone-process (process &optional newname)
4953 "Create a twin copy of PROCESS.
4954 If NEWNAME is nil, it defaults to PROCESS' name;
4955 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
4956 If PROCESS is associated with a buffer, the new process will be associated
4957 with the current buffer instead.
4958 Returns nil if PROCESS has already terminated."
4959 (setq newname (or newname (process-name process)))
4961 (setq newname (substring newname 0 (match-beginning 0))))
4962 (when (memq (process-status process) '(run stop open))
4963 (let* ((process-connection-type (process-tty-name process))
4964 (new-process
4965 (if (memq (process-status process) '(open))
4966 (let ((args (process-contact process t)))
4967 (setq args (plist-put args :name newname))
4968 (setq args (plist-put args :buffer
4969 (if (process-buffer process)
4970 (current-buffer))))
4971 (apply 'make-network-process args))
4972 (apply 'start-process newname
4973 (if (process-buffer process) (current-buffer))
4974 (process-command process)))))
4975 (set-process-query-on-exit-flag
4976 new-process (process-query-on-exit-flag process))
4977 (set-process-inherit-coding-system-flag
4978 new-process (process-inherit-coding-system-flag process))
4979 (set-process-filter new-process (process-filter process))
4980 (set-process-sentinel new-process (process-sentinel process))
4981 (set-process-plist new-process (copy-sequence (process-plist process)))
4982 new-process)))
4984 ;; things to maybe add (currently partly covered by `funcall mode'):
4985 ;; - syntax-table
4986 ;; - overlays
4987 (defun clone-buffer (&optional newname display-flag)
4988 "Create and return a twin copy of the current buffer.
4989 Unlike an indirect buffer, the new buffer can be edited
4990 independently of the old one (if it is not read-only).
4991 NEWNAME is the name of the new buffer. It may be modified by
4992 adding or incrementing <N> at the end as necessary to create a
4993 unique buffer name. If nil, it defaults to the name of the
4994 current buffer, with the proper suffix. If DISPLAY-FLAG is
4995 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
4996 clone a file-visiting buffer, or a buffer whose major mode symbol
4997 has a non-nil `no-clone' property, results in an error.
4999 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
5000 current buffer with appropriate suffix. However, if a prefix
5001 argument is given, then the command prompts for NEWNAME in the
5002 minibuffer.
5004 This runs the normal hook `clone-buffer-hook' in the new buffer
5005 after it has been set up properly in other respects."
5006 (interactive
5007 (progn
5008 (if buffer-file-name
5009 (error "Cannot clone a file-visiting buffer"))
5010 (if (get major-mode 'no-clone)
5011 (error "Cannot clone a buffer in %s mode" mode-name))
5012 (list (if current-prefix-arg (read-string "Name: "))
5013 t)))
5014 (if buffer-file-name
5015 (error "Cannot clone a file-visiting buffer"))
5016 (if (get major-mode 'no-clone)
5017 (error "Cannot clone a buffer in %s mode" mode-name))
5018 (setq newname (or newname (buffer-name)))
5020 (setq newname (substring newname 0 (match-beginning 0))))
5021 (let ((buf (current-buffer))
5022 (ptmin (point-min))
5023 (ptmax (point-max))
5024 (pt (point))
5025 (mk (if mark-active (mark t)))
5026 (modified (buffer-modified-p))
5027 (mode major-mode)
5028 (lvars (buffer-local-variables))
5029 (process (get-buffer-process (current-buffer)))
5030 (new (generate-new-buffer (or newname (buffer-name)))))
5031 (save-restriction
5032 (widen)
5033 (with-current-buffer new
5034 (insert-buffer-substring buf)))
5035 (with-current-buffer new
5036 (narrow-to-region ptmin ptmax)
5037 (goto-char pt)
5038 (if mk (set-mark mk))
5039 (set-buffer-modified-p modified)
5041 ;; Clone the old buffer's process, if any.
5042 (when process (clone-process process))
5044 ;; Now set up the major mode.
5045 (funcall mode)
5047 ;; Set up other local variables.
5048 (mapcar (lambda (v)
5049 (condition-case () ;in case var is read-only
5050 (if (symbolp v)
5051 (makunbound v)
5052 (set (make-local-variable (car v)) (cdr v)))
5053 (error nil)))
5054 lvars)
5056 ;; Run any hooks (typically set up by the major mode
5057 ;; for cloning to work properly).
5058 (run-hooks 'clone-buffer-hook))
5059 (if display-flag (pop-to-buffer new))
5060 new))
5063 (defun clone-indirect-buffer (newname display-flag &optional norecord)
5064 "Create an indirect buffer that is a twin copy of the current buffer.
5066 Give the indirect buffer name NEWNAME. Interactively, read NEW-NAME
5067 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
5068 or if not called with a prefix arg, NEWNAME defaults to the current
5069 buffer's name. The name is modified by adding a `<N>' suffix to it
5070 or by incrementing the N in an existing suffix.
5072 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
5073 This is always done when called interactively.
5075 Optional last arg NORECORD non-nil means do not put this buffer at the
5076 front of the list of recently selected ones."
5077 (interactive
5078 (progn
5079 (if (get major-mode 'no-clone-indirect)
5080 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
5081 (list (if current-prefix-arg
5082 (read-string "BName of indirect buffer: "))
5083 t)))
5084 (if (get major-mode 'no-clone-indirect)
5085 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
5086 (setq newname (or newname (buffer-name)))
5088 (setq newname (substring newname 0 (match-beginning 0))))
5089 (let* ((name (generate-new-buffer-name newname))
5090 (buffer (make-indirect-buffer (current-buffer) name t)))
5091 (when display-flag
5092 (pop-to-buffer buffer norecord))
5093 buffer))
5096 (defun clone-indirect-buffer-other-window (buffer &optional norecord)
5097 "Create an indirect buffer that is a twin copy of BUFFER.
5098 Select the new buffer in another window.
5099 Optional second arg NORECORD non-nil means do not put this buffer at
5100 the front of the list of recently selected ones."
5101 (interactive "bClone buffer in other window: ")
5102 (let ((pop-up-windows t))
5103 (set-buffer buffer)
5104 (clone-indirect-buffer nil t norecord)))
5106 (define-key ctl-x-4-map "c" 'clone-indirect-buffer-other-window)
5107 \f
5108 ;;; Handling of Backspace and Delete keys.
5110 (defcustom normal-erase-is-backspace
5111 (and (not noninteractive)
5112 (or (memq system-type '(ms-dos windows-nt))
5113 (eq window-system 'mac)
5114 (and (memq window-system '(x))
5115 (fboundp 'x-backspace-delete-keys-p)
5116 (x-backspace-delete-keys-p))
5117 ;; If the terminal Emacs is running on has erase char
5118 ;; set to ^H, use the Backspace key for deleting
5119 ;; backward and, and the Delete key for deleting forward.
5120 (and (null window-system)
5121 (eq tty-erase-char ?\^H))))
5122 "If non-nil, Delete key deletes forward and Backspace key deletes backward.
5124 On window systems, the default value of this option is chosen
5125 according to the keyboard used. If the keyboard has both a Backspace
5126 key and a Delete key, and both are mapped to their usual meanings, the
5127 option's default value is set to t, so that Backspace can be used to
5128 delete backward, and Delete can be used to delete forward.
5130 If not running under a window system, customizing this option accomplishes
5131 a similar effect by mapping C-h, which is usually generated by the
5132 Backspace key, to DEL, and by mapping DEL to C-d via
5133 `keyboard-translate'. The former functionality of C-h is available on
5134 the F1 key. You should probably not use this setting if you don't
5135 have both Backspace, Delete and F1 keys.
5137 Setting this variable with setq doesn't take effect. Programmatically,
5138 call `normal-erase-is-backspace-mode' (which see) instead."
5139 :type 'boolean
5140 :group 'editing-basics
5141 :version "21.1"
5142 :set (lambda (symbol value)
5143 ;; The fboundp is because of a problem with :set when
5144 ;; dumping Emacs. It doesn't really matter.
5145 (if (fboundp 'normal-erase-is-backspace-mode)
5146 (normal-erase-is-backspace-mode (or value 0))
5147 (set-default symbol value))))
5150 (defun normal-erase-is-backspace-mode (&optional arg)
5151 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
5153 With numeric arg, turn the mode on if and only if ARG is positive.
5155 On window systems, when this mode is on, Delete is mapped to C-d and
5156 Backspace is mapped to DEL; when this mode is off, both Delete and
5157 Backspace are mapped to DEL. (The remapping goes via
5158 `function-key-map', so binding Delete or Backspace in the global or
5159 local keymap will override that.)
5161 In addition, on window systems, the bindings of C-Delete, M-Delete,
5162 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
5163 the global keymap in accordance with the functionality of Delete and
5164 Backspace. For example, if Delete is remapped to C-d, which deletes
5165 forward, C-Delete is bound to `kill-word', but if Delete is remapped
5166 to DEL, which deletes backward, C-Delete is bound to
5167 `backward-kill-word'.
5169 If not running on a window system, a similar effect is accomplished by
5170 remapping C-h (normally produced by the Backspace key) and DEL via
5171 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
5172 to C-d; if it's off, the keys are not remapped.
5174 When not running on a window system, and this mode is turned on, the
5175 former functionality of C-h is available on the F1 key. You should
5176 probably not turn on this mode on a text-only terminal if you don't
5177 have both Backspace, Delete and F1 keys.
5179 See also `normal-erase-is-backspace'."
5180 (interactive "P")
5181 (setq normal-erase-is-backspace
5182 (if arg
5183 (> (prefix-numeric-value arg) 0)
5184 (not normal-erase-is-backspace)))
5186 (cond ((or (memq window-system '(x w32 mac pc))
5187 (memq system-type '(ms-dos windows-nt)))
5188 (let ((bindings
5189 `(([C-delete] [C-backspace])
5190 ([M-delete] [M-backspace])
5191 ([C-M-delete] [C-M-backspace])
5192 (,esc-map
5193 [C-delete] [C-backspace])))
5194 (old-state (lookup-key function-key-map [delete])))
5196 (if normal-erase-is-backspace
5197 (progn
5198 (define-key function-key-map [delete] [?\C-d])
5199 (define-key function-key-map [kp-delete] [?\C-d])
5200 (define-key function-key-map [backspace] [?\C-?]))
5201 (define-key function-key-map [delete] [?\C-?])
5202 (define-key function-key-map [kp-delete] [?\C-?])
5203 (define-key function-key-map [backspace] [?\C-?]))
5205 ;; Maybe swap bindings of C-delete and C-backspace, etc.
5206 (unless (equal old-state (lookup-key function-key-map [delete]))
5207 (dolist (binding bindings)
5208 (let ((map global-map))
5209 (when (keymapp (car binding))
5210 (setq map (car binding) binding (cdr binding)))
5211 (let* ((key1 (nth 0 binding))
5212 (key2 (nth 1 binding))
5213 (binding1 (lookup-key map key1))
5214 (binding2 (lookup-key map key2)))
5215 (define-key map key1 binding2)
5216 (define-key map key2 binding1)))))))
5217 (t
5218 (if normal-erase-is-backspace
5219 (progn
5220 (keyboard-translate ?\C-h ?\C-?)
5221 (keyboard-translate ?\C-? ?\C-d))
5222 (keyboard-translate ?\C-h ?\C-h)
5223 (keyboard-translate ?\C-? ?\C-?))))
5225 (run-hooks 'normal-erase-is-backspace-hook)
5226 (if (interactive-p)
5227 (message "Delete key deletes %s"
5228 (if normal-erase-is-backspace "forward" "backward"))))
5229 \f
5230 (defvar vis-mode-saved-buffer-invisibility-spec nil
5231 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
5233 (define-minor-mode visible-mode
5234 "Toggle Visible mode.
5235 With argument ARG turn Visible mode on iff ARG is positive.
5237 Enabling Visible mode makes all invisible text temporarily visible.
5238 Disabling Visible mode turns off that effect. Visible mode
5239 works by saving the value of `buffer-invisibility-spec' and setting it to nil."
5240 :lighter " Vis"
5241 :group 'editing-basics
5242 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
5243 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
5244 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
5245 (when visible-mode
5246 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
5247 buffer-invisibility-spec)
5248 (setq buffer-invisibility-spec nil)))
5249 \f
5250 ;; Minibuffer prompt stuff.
5252 ;(defun minibuffer-prompt-modification (start end)
5253 ; (error "You cannot modify the prompt"))
5254 ;
5255 ;
5256 ;(defun minibuffer-prompt-insertion (start end)
5257 ; (let ((inhibit-modification-hooks t))
5258 ; (delete-region start end)
5259 ; ;; Discard undo information for the text insertion itself
5260 ; ;; and for the text deletion.above.
5261 ; (when (consp buffer-undo-list)
5262 ; (setq buffer-undo-list (cddr buffer-undo-list)))
5263 ; (message "You cannot modify the prompt")))
5264 ;
5265 ;
5266 ;(setq minibuffer-prompt-properties
5267 ; (list 'modification-hooks '(minibuffer-prompt-modification)
5268 ; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
5269 ;
5271 (provide 'simple)
5273 ;; arch-tag: 24af67c0-2a49-44f6-b3b1-312d8b570dfd
5274 ;;; simple.el ends here