| blob | efe1559cb4df70b06ac43b529b84989d3da39b9e |
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 Free Software Foundation, Inc.
6 ;; Maintainer: FSF
7 ;; Keywords: internal
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
26 ;;; Commentary:
28 ;; A grab-bag of basic Emacs commands not specifically related to some
29 ;; major mode or to file-handling.
31 ;;; Code:
40 "*Idle time delay before updating various things on the screen.
41 Various Emacs features that update auxiliary information when point moves
42 wait this many seconds after Emacs becomes idle before doing an update."
48 "Killing and yanking commands."
52 "Highlight (un)matching of parens and expressions."
56 "Switch to the next buffer in cyclic order."
63 "Switch to the previous buffer in cyclic order."
66 found)
74 \f
75 ;;; next-error support framework
78 "`next-error' support framework."
84 "Face used to highlight next error locus."
89 "*Highlighting of locations in selected source buffers.
90 If number, highlight the locus in `next-error' face for given time in seconds.
91 If t, use persistent overlays fontified in `next-error' face.
92 If nil, don't highlight the locus in the source buffer.
93 If `fringe-arrow', indicate the locus by the fringe arrow."
102 "*Highlighting of locations in non-selected source buffers.
103 If number, highlight the locus in `next-error' face for given time in seconds.
104 If t, use persistent overlays fontified in `next-error' face.
105 If nil, don't highlight the locus in the source buffer.
106 If `fringe-arrow', indicate the locus by the fringe arrow."
115 "*List of hook functions run by `next-error' after visiting source file."
126 "The most recent `next-error' buffer.
127 A buffer becomes most recent when its compilation, grep, or
132 "Function to use to find the next error in the current buffer.
133 The function is called with 2 parameters:
134 ARG is an integer specifying by how many errors to move.
135 RESET is a boolean which, if non-nil, says to go back to the beginning
136 of the errors before moving.
137 Major modes providing compile-like functionality should set this variable
138 to indicate to `next-error' that this is a candidate buffer and how
144 &optional avoid-current
145 extra-test-inclusive
146 extra-test-exclusive)
147 "Test if BUFFER is a `next-error' capable buffer.
149 If AVOID-CURRENT is non-nil, treat the current buffer
150 as an absolute last resort only.
152 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
153 that normally would not qualify. If it returns t, the buffer
154 in question is treated as usable.
156 The function EXTRA-TEST-EXCLUSIVE, if non-nil is called in each buffer
157 that would normally be considered usable. If it returns nil,
158 that buffer is rejected."
163 ;; Optionally reject some buffers.
166 t)
167 ;; Optionally accept some other buffers.
172 extra-test-inclusive
173 extra-test-exclusive)
174 "Return a `next-error' capable buffer.
175 If AVOID-CURRENT is non-nil, treat the current buffer
176 as an absolute last resort only.
178 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
179 that normally would not qualify. If it returns t, the buffer
180 in question is treated as usable.
182 The function EXTRA-TEST-EXCLUSIVE, if non-nil is called in each buffer
183 that would normally be considered usable. If it returns nil,
184 that buffer is rejected."
186 ;; 1. If one window on the selected frame displays such buffer, return it.
192 avoid-current
193 extra-test-inclusive extra-test-exclusive)
198 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
201 extra-test-inclusive extra-test-exclusive))
202 next-error-last-buffer)
203 ;; 3. If the current buffer is acceptable, choose it.
205 extra-test-inclusive extra-test-exclusive)
207 ;; 4. Look for any acceptable buffer.
212 extra-test-inclusive extra-test-exclusive)))
215 ;; 5. Use the current buffer as a last resort if it qualifies,
216 ;; even despite AVOID-CURRENT.
219 extra-test-inclusive extra-test-exclusive)
223 ;; 6. Give up.
227 "Visit next `next-error' message and corresponding source code.
229 If all the error messages parsed so far have been processed already,
230 the message buffer is checked for new ones.
232 A prefix ARG specifies how many error messages to move;
233 negative means move back to previous error messages.
235 and start at the first error.
237 The RESET argument specifies that we should restart from the beginning.
240 compilation, grep, or occur buffer. It can also operate on any
242 more generally, on any buffer in Compilation mode or with
243 Compilation Minor mode enabled, or any buffer in which
244 `next-error-function' is bound to an appropriate function.
245 To specify use of a particular buffer for error messages, type
247 in the current frame.
250 runs `next-error-hook' with `run-hooks', and stays with that buffer
251 until you use it in some other buffer which uses Compilation mode
252 or Compilation Minor mode.
254 See variables `compilation-parse-errors-function' and
255 \`compilation-error-regexp-alist' for customization ideas."
259 ;; we know here that next-error-function is a valid symbol we can funcall
265 "Visit the source code corresponding to the `next-error' message at point."
267 ;; we know here that next-error-function is a valid symbol we can funcall
276 "Visit previous `next-error' message and corresponding source code.
278 Prefix arg N says how many error messages to move backwards (or
279 forwards, if negative).
286 "Restart at the first error.
287 Visit corresponding source code.
288 With prefix arg N, visit the source code of the Nth error.
294 "Move point to the next error in the `next-error' buffer and highlight match.
295 Prefix arg N says how many error messages to move forwards (or
296 backwards, if negative).
298 select the source buffer."
305 "Move point to the previous error in the `next-error' buffer and highlight match.
306 Prefix arg N says how many error messages to move backwards (or
307 forwards, if negative).
309 select the source buffer."
313 ;;; Internal variable for `next-error-follow-mode-post-command-hook'.
317 "Minor mode for compilation, occur and diff modes.
318 When turned on, cursor motion in the compilation, grep, occur or diff
319 buffer causes automatic display of the corresponding source code
320 location."
327 ;;; Used as a `post-command-hook' by `next-error-follow-mode'
328 ;;; for the *Compilation* *grep* and *Occur* buffers.
338 \f
339 ;;;
342 "Major mode not specialized for anything in particular.
343 Other major modes are defined by comparison with this one."
349 ;; Making and deleting lines.
352 "Insert a newline, and move to left margin of the new line if it's blank.
353 If `use-hard-newlines' is non-nil, the newline is marked with the
354 text-property `hard'.
355 With ARG, insert that many newlines.
356 Call `auto-fill-function' if the current column number is greater
357 than the value of `fill-column' and ARG is nil."
360 ;; Inserting a newline at the end of a line produces better redisplay in
361 ;; try_window_id than inserting at the beginning of a line, and the textual
362 ;; result is the same. So, if we're at beginning of line, pretend to be at
363 ;; the end of the previous line.
366 ;; Make sure no functions want to be told about
367 ;; the range of the changes.
370 ;; Make sure there are no markers here.
373 ;; Make sure no text properties want to know
374 ;; where the change was.
379 ;; Make sure the newline before point isn't intangible.
381 ;; Make sure the newline before point isn't read-only.
383 ;; Make sure the newline before point isn't invisible.
385 ;; Make sure the newline before point has the same
386 ;; properties as the char before it (if any).
393 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
394 ;; Set last-command-char to tell self-insert what to insert.
396 ;; Don't auto-fill if we have a numeric argument.
397 ;; Also not if flag is true (it would fill wrong line);
398 ;; there is no need to since we're at BOL.
402 ;; If we get an error in self-insert-command, put point at right place.
404 ;; Even if we did *not* get an error, keep that forward-char;
405 ;; all further processing should apply to the newline that the user
406 ;; thinks he inserted.
408 ;; Mark the newline(s) `hard'.
412 ;; If the newline leaves the previous line blank,
413 ;; and we have a left margin, delete that from the blank line.
421 ;; Indent the line after the newline, except in one case:
422 ;; when we added the newline at the beginning of a line
423 ;; which starts a page.
426 nil)
431 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
437 "Insert a newline and leave point before it.
438 If there is a fill prefix and/or a `left-margin', insert them
439 on the new line if the line would have been blank.
440 With arg N, insert N newlines."
445 ;; Don't expand an abbrev before point.
459 "Split current line, moving portion beyond point vertically down.
460 If the current line starts with `fill-prefix', insert it on the new
461 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
463 When called from Lisp code, ARG may be a prefix string to copy."
468 ;; What prefix should we check for (nil means don't).
472 ;; Does this line start with it?
483 "Join this line to previous and fix up whitespace at join.
484 If there is a fill prefix, delete it from the beginning of this line.
485 With argument, join this line to following line."
492 ;; If the second line started with the fill prefix,
493 ;; delete the prefix.
505 "On blank line, delete all surrounding blank lines, leaving just one.
506 On isolated blank line, delete that one.
507 On nonblank line, delete any immediately following blank lines."
513 ;; Set singleblank if there is just one blank line here.
520 ;; Delete preceding blank lines, and this one too if it's the only one.
529 ;; Delete following blank lines, unless the current line is blank
530 ;; and there are no following blank lines.
539 ;; Handle the special case where point is followed by newline and eob.
540 ;; Delete the line, leaving point at eob.
545 "Delete all the trailing whitespace across the current buffer.
546 All whitespace after the last non-whitespace character in a line is deleted.
548 A formfeed is not considered whitespace by this function."
555 ;; Don't delete formfeeds, even if they are considered whitespace.
562 "Insert a newline, then indent according to major mode.
563 Indentation is done using the value of `indent-line-function'.
564 In programming language modes, this is the same as TAB.
565 In some text modes, where TAB inserts a tab, this command indents to the
566 column specified by the function `current-left-margin'."
573 "Reindent current line, insert newline, then indent the new line.
574 Indentation of both lines is done according to the current major mode,
575 which means calling the current value of `indent-line-function'.
576 In programming language modes, this is the same as TAB.
577 In some text modes, where TAB inserts a tab, this indents to the
578 column specified by the function `current-left-margin'."
581 ;; Be careful to insert the newline before indenting the line.
582 ;; Otherwise, the indentation might be wrong.
591 "Read next input character and insert it.
592 This is useful for inserting control characters.
594 If the first character you type after this command is an octal digit,
595 you should type a sequence of octal digits which specify a character code.
596 Any nondigit terminates the sequence. If the terminator is a RET,
597 it is discarded; any other terminator is used itself as input.
598 The variable `read-quoted-char-radix' specifies the radix for this feature;
599 set it to 10 or 16 to use decimal or hex instead of octal.
601 In overwrite mode, this function inserts the character anyway, and
602 does not handle octal digits specially. This means that if you use
603 overwrite as your normal editing mode, you can use this function to
604 insert characters when necessary.
606 In binary overwrite mode, this function does overwrite, and octal
607 digits are interpreted as a character code. This is intended to be
608 useful for editing binary files."
615 ;; Assume character codes 0240 - 0377 stand for characters in some
616 ;; single-byte character set, and convert them to Emacs
617 ;; characters.
630 "Move forward ARG lines and position at first nonblank character."
636 "Move backward ARG lines and position at first nonblank character."
642 "Move point to the first non-whitespace character on this line."
646 ;; Move back over chars that have whitespace syntax but have the p flag.
650 "Fixup white space between objects around point.
651 Leave one space or none, according to the context."
658 nil
662 "Delete all spaces and tabs around point.
663 If BACKWARD-ONLY is non-nil, only delete spaces before point."
668 orig-pos
677 "Delete all spaces and tabs around point, leaving one space (or N spaces)."
691 \f
693 "Move point to the beginning of the buffer; leave mark at previous position.
695 With numeric arg N, put point N/10 of the way from the beginning.
697 If the buffer is narrowed, this command uses the beginning and size
698 of the accessible part of the buffer.
700 Don't use this command in Lisp programs!
701 \(goto-char (point-min)) is faster and avoids clobbering the mark."
710 ;; Avoid overflow for large buffer sizes!
718 "Move point to the end of the buffer; leave mark at previous position.
720 With numeric arg N, put point N/10 of the way from the end.
722 If the buffer is narrowed, this command uses the beginning and size
723 of the accessible part of the buffer.
725 Don't use this command in Lisp programs!
726 \(goto-char (point-max)) is faster and avoids clobbering the mark."
735 ;; Avoid overflow for large buffer sizes!
740 ;; If we went to a place in the middle of the buffer,
741 ;; adjust it to the beginning of a line.
744 ;; If the end of the buffer is not already on the screen,
745 ;; then scroll specially to put it near, but not at, the bottom.
750 "Put point at beginning and mark at end of buffer.
751 You probably should not use this function in Lisp programs;
752 it is usually a mistake for a Lisp function to use any subroutine
753 that uses or sets the mark."
758 \f
760 ;; Counting lines, one way or another.
763 "Goto line ARG, counting from line 1 at beginning of buffer.
764 Normally, move point in the current buffer.
766 displayed other buffer, and switch to it. When called from Lisp code,
767 the optional argument BUFFER specifies a buffer to switch to.
769 If there's a number in the buffer at point, it is the default for ARG."
773 ;; Look for a default, a number in the buffer at point.
782 ;; Decide if we're switching buffers.
790 ;; Read the argument, offering that number (if any) as default.
793 buffer-prompt
794 default)
795 nil nil t
796 'minibuffer-history
797 default)
798 buffer))))
799 ;; Switch to the desired buffer, one way or another.
804 ;; Move to the specified line number in that buffer.
813 "Print number of lines and characters in the region."
819 "Print the current buffer line number and narrowed line number of point."
832 "Return number of lines between START and END.
833 This is usually the number of newlines between them,
834 but can be one more if START is not equal to END
835 and the greater of them is not at the start of a line."
851 done)))
855 "Return (narrowed) buffer line number at position POS.
856 If POS is nil, use current buffer location."
866 "Print info on cursor position (on screen and within buffer).
867 Also describe the character after point, and give its character code
868 in octal, decimal and hex.
870 For a non-ASCII multibyte character, also give its encoding in the
871 buffer's selected coding system if the coding system encodes the
872 character safely. If the character is encoded into one byte, that
873 code is shown in hex. If the character is encoded into more than one
876 In addition, with prefix argument, show details about that character
877 in *Help* buffer. See also the command `describe-char'."
885 ;; Avoid overflow from multiplying by 100!
889 ""
895 pos total percent beg end col hscroll)
897 pos total percent col hscroll))
899 encoded encoding-msg display-prop under-display)
906 ;; Check if the character is displayed with some `display'
907 ;; text property. In that case, set under-display to the
908 ;; buffer substring covered by that property.
919 under-display)))
925 char char char under-display)
927 char char char under-display display-prop))
930 char char char
932 "..."
936 ;; We show the detailed information about CHAR.
943 encoding-msg pos total percent beg end col hscroll)
950 encoding-msg pos total percent col hscroll))))))
951 \f
956 m)
962 "Value for `print-level' while printing value in `eval-expression'.
963 A value of nil means no limit."
969 "Value for `print-length' while printing value in `eval-expression'.
970 A value of nil means no limit."
976 "If non-nil set `debug-on-error' to t in `eval-expression'.
977 If nil, don't change the value of `debug-on-error'."
983 "Format VALUE as a result of evaluated expression.
984 Return a formatted string which is displayed in the echo area
985 in addition to the value printed by prin1 in functions which
986 display the result of expression evaluation."
999 ;; We define this, rather than making `eval' interactive,
1000 ;; for the sake of completion of names like eval-region, eval-current-buffer.
1003 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
1004 Value is also consed on to front of the variable `values'.
1005 Optional argument EVAL-EXPRESSION-INSERT-VALUE, if non-nil, means
1006 insert the result into the current buffer instead of printing it in
1007 the echo area."
1010 nil read-expression-map t
1012 current-prefix-arg))
1017 ;; Bind debug-on-error to something unique so that we can
1018 ;; detect when evaled code changes it.
1022 ;; If evaled code has changed the value of debug-on-error,
1023 ;; propagate that change to the global binding.
1039 "Prompting with PROMPT, let user edit COMMAND and eval result.
1040 COMMAND is a Lisp expression. Let user edit that expression in
1041 the minibuffer, then read and evaluate the result."
1048 read-expression-map t
1050 ;; If command was added to command-history as a string,
1051 ;; get rid of that. We want only evaluable expressions there.
1055 ;; If command to be redone does not match front of history,
1056 ;; add it to the history.
1062 "Edit and re-evaluate last complex command, or ARGth from last.
1063 A complex command is one which used the minibuffer.
1064 The command is placed in the minibuffer as a Lisp form for editing.
1065 The result is executed, repeating the command as changed.
1066 If the command has been changed or is not the most recent previous command
1067 it is added to the front of the command history.
1068 You can use the minibuffer history commands \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
1069 to get different commands to edit and resubmit."
1072 newcmd)
1084 ;; If command was added to command-history as a
1085 ;; string, get rid of that. We want only
1086 ;; evaluable expressions there.
1090 ;; If command to be redone does not match front of history,
1091 ;; add it to the history.
1098 \f
1100 "Default minibuffer history list.
1101 This is used for all minibuffer input
1104 "Control whether history list elements are expressions or strings.
1105 If the value of this variable equals current minibuffer depth,
1106 they are expressions; otherwise they are strings.
1107 \(That convention is designed to do the right thing fora
1114 "Text that was in this minibuffer before any history commands.
1115 This is nil if there have not yet been any history commands
1124 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1128 "*Minibuffer history variables for which matching should ignore case.
1129 If a history variable is a member of this list, then the
1131 commands ignore case when searching it, regardless of `case-fold-search'."
1136 "Find the previous history element that matches REGEXP.
1137 \(Previous history elements refer to earlier actions.)
1138 With prefix argument N, search for Nth previous match.
1139 If N is negative, find the next or Nth next match.
1140 Normally, history elements are matched case-insensitively if
1141 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1142 makes the search case-sensitive.
1143 See also `minibuffer-history-case-insensitive-variables'."
1147 nil
1148 minibuffer-local-map
1149 nil
1150 'minibuffer-history-search-history
1152 ;; Use the last regexp specified, by default, if input is empty.
1157 regexp)
1167 ;; On some systems, ignore case for file names.
1169 minibuffer-history-case-insensitive-variables)
1170 t
1171 ;; Respect the user's setting for case-fold-search:
1172 case-fold-search)
1173 nil))
1174 prevpos
1175 match-string
1176 match-offset
1183 "No later matching history item"
1204 next-matching-history-element))
1208 "Find the next history element that matches REGEXP.
1209 \(The next history element refers to a more recent action.)
1210 With prefix argument N, search for Nth next match.
1211 If N is negative, find the previous or Nth previous match.
1212 Normally, history elements are matched case-insensitively if
1213 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1214 makes the search case-sensitive."
1218 nil
1219 minibuffer-local-map
1220 nil
1221 'minibuffer-history-search-history
1223 ;; Use the last regexp specified, by default, if input is empty.
1228 regexp)
1235 "Insert the next element of the minibuffer history into the minibuffer."
1240 elt minibuffer-returned-to-present)
1252 previous-history-element))
1274 elt))
1278 "Inserts the previous element of the minibuffer history into the minibuffer."
1283 "Get next history element which completes the minibuffer before the point.
1284 The contents of the minibuffer after the point are deleted, and replaced
1285 by the new completion."
1291 n)
1292 ;; next-matching-history-element always puts us at (point-min).
1293 ;; Move to the position we were at before changing the buffer contents.
1294 ;; This is still sensical, because the text before point has not changed.
1298 "\
1299 Get previous history element which completes the minibuffer before the point.
1300 The contents of the minibuffer after the point are deleted, and replaced
1301 by the new completion."
1305 ;; For compatibility with the old subr of the same name.
1307 "Return the display width of the minibuffer prompt.
1308 Return 0 if current buffer is not a minibuffer."
1309 ;; Return the width of everything before the field at the end of
1310 ;; the buffer; this should be 0 for normal buffers.
1312 \f
1313 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1317 "Table mapping redo records to the corresponding undo one.
1318 A redo record for undo-in-region maps to t.
1328 "Within a run of consecutive undo commands, list remaining to be undone.
1332 "Undo some previous changes.
1333 Repeat this command to undo more changes.
1334 A numeric argument serves as a repeat count.
1336 In Transient Mark mode when the mark is active, only undo changes within
1338 as an argument limits undo to changes within the current region."
1340 ;; Make last-command indicate for the next command that this was an undo.
1341 ;; That way, another undo will undo more.
1342 ;; If we get to the end of the undo history and get an error,
1343 ;; another undo command will find the undo history empty
1344 ;; and will get another error. To begin undoing the undos,
1345 ;; you must type some other command.
1348 ;; If we get an error in undo-start,
1349 ;; the next command should not be a "consecutive undo".
1350 ;; So set `this-command' to something other than `undo'.
1355 ;; If something (a timer or filter?) changed the buffer
1356 ;; since the previous command, don't continue the undo seq.
1360 ;; If the last undo record made was made by undo
1361 ;; it shows nothing else happened in between.
1368 ;; get rid of initial undo boundary
1370 ;; If we got this far, the next command should be a consecutive undo.
1372 ;; Check to see whether we're hitting a redo record, and if
1373 ;; so, ask the user whether she wants to skip the redo/undo pair.
1380 ;; The equiv entry might point to another redo record if we have done
1381 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1389 ;; Record the fact that the just-generated undo records come from an
1390 ;; undo operation--that is, they are redo records.
1391 ;; In the ordinary case (not within a region), map the redo
1392 ;; record to the following undos.
1393 ;; I don't know how to do that in the undo-in-region case.
1396 undo-equiv-table)
1397 ;; Don't specify a position in the undo record for the undo command.
1398 ;; Instead, undoing this should move point to where the change is.
1417 ;; Record what the current undo list says,
1418 ;; so the next command can tell if the buffer was modified in between.
1423 "Make BUFFER stop keeping undo information.
1424 No argument or nil as argument means do this for the current buffer."
1430 "Undo some previous changes.
1431 Repeat this command to undo more changes.
1432 A numeric argument serves as a repeat count.
1433 Contrary to `undo', this will not redo a previous undo."
1438 "Non-nil while performing an undo.
1442 "Undo back N undo-boundaries beyond what was already undone recently.
1443 Call `undo-start' to get ready to undo recent changes,
1444 then call `undo-more' one or more times to undo them."
1454 ;; Deep copy of a list
1456 "Make a copy of undo list LIST."
1462 elt))
1465 "Set `pending-undo-list' to the front of the undo list.
1466 The next call to `undo-more' will undo the most recently made change.
1467 If BEG and END are specified, then only undo elements
1468 that apply to text between BEG and END are used; other undo elements
1469 are ignored. If BEG and END are nil, all undo elements are used."
1475 buffer-undo-list)))
1480 "Return a list of undo elements for the region START to END.
1481 The elements come from `buffer-undo-list', but we keep only
1482 the elements inside this region, and discard those outside this region.
1483 If we find an element that crosses an edge of this region,
1484 we stop and ignore all further elements."
1487 undo-adjusted-markers
1488 some-rejected
1489 undo-elt undo-elt temp-undo-list delta)
1494 ;; This is a "was unmodified" element.
1495 ;; Keep it if we have kept everything thus far.
1502 ;; Don't put two nils together in the list
1516 ;; Loop down the earlier events adjusting their buffer
1517 ;; positions to reflect the fact that a change to the buffer
1518 ;; isn't being undone. We only need to process those element
1519 ;; types which undo-elt-in-region will return as being in
1520 ;; the region since only those types can ever get into the
1521 ;; output
1530 ;; (TEXT . POSITION)
1537 ;; (BEGIN . END)
1542 ;; (nil PROPERTY VALUE BEG . END)
1552 "Determine whether UNDO-ELT falls inside the region START ... END.
1553 If it crosses the edge, we return nil."
1558 t)
1560 nil)
1562 ;; (TEXT . POSITION)
1566 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1567 ;; See if MARKER is inside the region.
1578 ;; (nil PROPERTY VALUE BEG . END)
1583 ;; (BEGIN . END)
1588 "Test whether UNDO-ELT crosses one edge of that region START ... END.
1589 This assumes we have already decided that UNDO-ELT
1590 is not *inside* the region START...END."
1593 ;; (nil PROPERTY VALUE BEG . END)
1598 ;; (BEGIN . END)
1602 ;; Return the first affected buffer position and the delta for an undo element
1603 ;; delta is defined as the change in subsequent buffer positions if we *did*
1604 ;; the undo.
1608 ;; (TEXT . POSITION)
1611 ;; (BEGIN . END)
1618 "If non-nil ask about discarding undo info for the current command.
1619 Normally, Emacs discards the undo info for the current command if
1620 it exceeds `undo-outer-limit'. But if you set this option
1621 non-nil, it asks in the echo area whether to discard the info.
1622 If you answer no, there a slight risk that Emacs might crash, so
1623 only do it if you really want to undo the command.
1625 This option is mainly intended for debugging. You have to be
1626 careful if you use it for other purposes. Garbage collection is
1627 inhibited while the question is asked, meaning that Emacs might
1628 leak memory. So you should make sure that you do not wait
1629 excessively long before answering the question."
1635 "If non-nil, an extra level of size that's ok in an undo item.
1636 We don't ask the user about truncating the undo list until the
1637 current item gets bigger than this amount.
1642 ;; When the first undo batch in an undo list is longer than
1643 ;; undo-outer-limit, this function gets called to warn the user that
1644 ;; the undo info for the current command was discarded. Garbage
1645 ;; collection is inhibited around the call, so it had better not do a
1646 ;; lot of consing.
1652 ;; Don't ask the question again unless it gets even bigger.
1653 ;; This applies, in particular, if the user quits from the question.
1654 ;; Such a quit quits out of GC, but something else will call GC
1655 ;; again momentarily. It will call this function again,
1656 ;; but we don't want to ask the question again.
1663 t)
1664 nil))
1669 "The undo info was discarded because it exceeded \
1670 `undo-outer-limit'.
1672 This is normal if you executed a command that made a huge change
1673 to the buffer. In that case, to prevent similar problems in the
1674 future, set `undo-outer-limit' to a value that is large enough to
1675 cover the maximum size of normal changes you expect a single
1676 command to make, but not so large that it might exceed the
1677 maximum memory allotted to Emacs.
1679 If you did not execute any such command, the situation is
1680 probably due to a bug and you should report it.
1682 You can disable the popping up of this buffer by adding the entry
1686 t))
1687 \f
1695 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
1696 This buffer is used when `shell-command' or `shell-command-on-region'
1697 is run interactively. A value of nil means that output to stderr and
1701 "Execute string COMMAND in inferior shell; display output, if any.
1702 With prefix argument, insert the COMMAND's output at point.
1704 If COMMAND ends in ampersand, execute it asynchronously.
1705 The output appears in the buffer `*Async Shell Command*'.
1706 That buffer is in shell mode.
1708 Otherwise, COMMAND is executed synchronously. The output appears in
1709 the buffer `*Shell Command Output*'. If the output is short enough to
1710 display in the echo area (which is determined by the variables
1711 `resize-mini-windows' and `max-mini-window-height'), it is shown
1712 there, but it is nonetheless available in buffer `*Shell Command
1713 Output*' even though that buffer is not automatically displayed.
1715 To specify a coding system for converting non-ASCII characters
1717 before this command.
1719 Noninteractive callers can specify coding systems by binding
1720 `coding-system-for-read' and `coding-system-for-write'.
1722 The optional second argument OUTPUT-BUFFER, if non-nil,
1723 says to put the output in some other buffer.
1724 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1725 If OUTPUT-BUFFER is not a buffer and not nil,
1726 insert output in current buffer. (This cannot be done asynchronously.)
1727 In either case, the output is inserted after point (leaving mark after it).
1729 If the command terminates without error, but generates output,
1731 the output can be displayed in the echo area or in its buffer.
1732 If the output is short enough to display in the echo area
1733 \(determined by the variable `max-mini-window-height' if
1734 `resize-mini-windows' is non-nil), it is shown there. Otherwise,
1735 the buffer containing the output is displayed.
1739 of the output.
1741 If there is no output, or if output is inserted in the current buffer,
1742 then `*Shell Command Output*' is deleted.
1744 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
1745 or buffer name to which to direct the command's standard error output.
1746 If it is nil, error output is mingled with regular output.
1747 In an interactive call, the variable `shell-command-default-error-buffer'
1748 specifies the value of ERROR-BUFFER."
1752 current-prefix-arg
1753 shell-command-default-error-buffer))
1754 ;; Look for a handler in case default-directory is a remote file name.
1762 ;; Output goes in current buffer.
1768 temporary-file-directory)))
1769 nil)))
1772 ;; We do not use -f for csh; we will not support broken use of
1773 ;; .cshrcs. Even the BSD csh manual says to use
1774 ;; "if ($?prompt) exit" before things which are not useful
1775 ;; non-interactively. Besides, if someone wants their other
1776 ;; aliases for shell commands then they can still have them.
1780 t)
1781 nil shell-command-switch command)
1788 ;; Do no formatting while reading error file,
1789 ;; because that can run a shell command, and we
1790 ;; don't want that to cause an infinite recursion.
1792 ;; Put point after the inserted errors.
1796 ;; This is like exchange-point-and-mark, but doesn't
1797 ;; activate the mark. It is cleaner to avoid activation,
1798 ;; even though the command loop would deactivate the mark
1799 ;; because we inserted text.
1803 ;; Output goes in a separate buffer.
1804 ;; Preserve the match data in case called from a program.
1807 ;; Command ending with ampersand means asynchronous.
1811 proc)
1812 ;; Remove the ampersand.
1814 ;; If will kill a process, query first.
1826 shell-command-switch command))
1830 ))
1832 output-buffer nil error-buffer)))))))
1836 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
1837 MESSAGE may be either a string or a buffer.
1839 A buffer is displayed using `display-buffer' if MESSAGE is too long for
1840 the maximum height of the echo area, as defined by `max-mini-window-height'
1841 if `resize-mini-windows' is non-nil.
1843 Returns either the string shown in the echo area, or when a pop-up
1844 buffer is used, the window used to display it.
1846 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
1847 name of the buffer used to display it in the case where a pop-up buffer
1848 is used, defaulting to `*Message*'. In the case where MESSAGE is a
1849 string and it is displayed in the echo area, it is not specified whether
1850 the contents are inserted into the buffer anyway.
1852 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
1853 and only used if a buffer is displayed."
1855 ;; Trivial case where we can use the echo area
1859 ;; Trivial case where we can just remove single trailing newline
1862 ;; General case
1865 message
1874 0
1878 (<= lines
1882 max-mini-window-height))
1884 max-mini-window-height)
1888 ;; Don't use the echo area if the output buffer is
1889 ;; already dispayed in the selected frame.
1891 ;; Echo area
1897 ;; Buffer
1900 not-this-window frame))))))))
1903 ;; We have a sentinel to prevent insertion of a termination message
1904 ;; in the buffer itself.
1912 &optional output-buffer replace
1913 error-buffer display-error-buffer)
1914 "Execute string COMMAND in inferior shell with region as input.
1915 Normally display output (if any) in temp buffer `*Shell Command Output*';
1916 Prefix arg means replace the region with it. Return the exit code of
1917 COMMAND.
1919 To specify a coding system for converting non-ASCII characters
1921 before this command. By default, the input (from the current buffer)
1922 is encoded in the same coding system that will be used to save the file,
1923 `buffer-file-coding-system'. If the output is going to replace the region,
1924 then it is decoded from that same coding system.
1926 The noninteractive arguments are START, END, COMMAND,
1927 OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
1928 Noninteractive callers can specify coding systems by binding
1929 `coding-system-for-read' and `coding-system-for-write'.
1931 If the command generates output, the output may be displayed
1932 in the echo area or in a buffer.
1933 If the output is short enough to display in the echo area
1934 \(determined by the variable `max-mini-window-height' if
1935 `resize-mini-windows' is non-nil), it is shown there. Otherwise
1936 it is displayed in the buffer `*Shell Command Output*'. The output
1937 is available in that buffer in both cases.
1939 If there is output and an error, a message about the error
1940 appears at the end of the output.
1942 If there is no output, or if output is inserted in the current buffer,
1943 then `*Shell Command Output*' is deleted.
1945 If the optional fourth argument OUTPUT-BUFFER is non-nil,
1946 that says to put the output in some other buffer.
1947 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1948 If OUTPUT-BUFFER is not a buffer and not nil,
1949 insert output in the current buffer.
1950 In either case, the output is inserted after point (leaving mark after it).
1952 If REPLACE, the optional fifth argument, is non-nil, that means insert
1953 the output in place of text from START to END, putting point and mark
1954 around it.
1956 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
1957 or buffer name to which to direct the command's standard error output.
1958 If it is nil, error output is mingled with regular output.
1959 If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
1960 were any errors. (This is always t, interactively.)
1961 In an interactive call, the variable `shell-command-default-error-buffer'
1962 specifies the value of ERROR-BUFFER."
1966 ;; Do this before calling region-beginning
1967 ;; and region-end, in case subprocess output
1968 ;; relocates them while we are in the minibuffer.
1970 nil nil nil
1972 ;; call-interactively recognizes region-beginning and
1973 ;; region-end specially, leaving them in the history.
1975 string
1976 current-prefix-arg
1977 current-prefix-arg
1978 shell-command-default-error-buffer
1979 t)))
1985 temporary-file-directory)))
1986 nil))
1987 exit-status)
1991 ;; Replace specified region with output from command.
1993 ;; Don't muck with mark unless REPLACE says we should.
2000 t)
2001 nil shell-command-switch command))
2002 ;; It is rude to delete a buffer which the command is not using.
2003 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2004 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2005 ;; (kill-buffer shell-buffer)))
2006 ;; Don't muck with mark unless REPLACE says we should.
2008 ;; No prefix argument: put the output in a temp buffer,
2009 ;; replacing its entire contents.
2014 ;; If the input is the same buffer as the output,
2015 ;; delete everything but the specified region,
2016 ;; then replace that region with the output.
2022 shell-file-name t
2025 t)
2026 nil shell-command-switch
2027 command)))
2028 ;; Clear the output buffer, then run the command with
2029 ;; output there.
2041 buffer)
2042 nil shell-command-switch command)))
2043 ;; Report the output.
2053 ;; There's some output, display it
2055 ;; No output; error?
2059 "some error output"
2065 output))
2068 exit-status))
2071 exit-status output))))
2072 ;; Don't kill: there might be useful info in the undo-log.
2073 ;; (kill-buffer buffer)
2074 ))))
2082 ;; Do no formatting while reading error file,
2083 ;; because that can run a shell command, and we
2084 ;; don't want that to cause an infinite recursion.
2086 ;; Put point after the inserted errors.
2091 exit-status))
2094 "Execute shell command COMMAND and return its output as a string."
2097 standard-output
2101 "Process files synchronously in a separate process.
2102 Similar to `call-process', but may invoke a file handler based on
2103 `default-directory'. The current working directory of the
2104 subprocess is `default-directory'.
2106 File names in INFILE and BUFFER are handled normally, but file
2107 names in ARGS should be relative to `default-directory', as they
2108 are passed to the process verbatim. \(This is a difference to
2109 `call-process' which does not support file handlers for INFILE
2110 and BUFFER.\)
2112 Some file handlers might not support all variants, for example
2113 they might behave as if DISPLAY was nil, regardless of the actual
2114 value passed."
2116 lc stderr-file)
2126 display args)
2132 \f
2136 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
2137 (define-key map [switch-frame] nil)
2138 (define-key map [?\C-u] 'universal-argument-more)
2139 (define-key map [?-] 'universal-argument-minus)
2140 (define-key map [?0] 'digit-argument)
2141 (define-key map [?1] 'digit-argument)
2142 (define-key map [?2] 'digit-argument)
2143 (define-key map [?3] 'digit-argument)
2144 (define-key map [?4] 'digit-argument)
2145 (define-key map [?5] 'digit-argument)
2146 (define-key map [?6] 'digit-argument)
2147 (define-key map [?7] 'digit-argument)
2148 (define-key map [?8] 'digit-argument)
2149 (define-key map [?9] 'digit-argument)
2150 (define-key map [kp-0] 'digit-argument)
2151 (define-key map [kp-1] 'digit-argument)
2152 (define-key map [kp-2] 'digit-argument)
2153 (define-key map [kp-3] 'digit-argument)
2154 (define-key map [kp-4] 'digit-argument)
2155 (define-key map [kp-5] 'digit-argument)
2156 (define-key map [kp-6] 'digit-argument)
2157 (define-key map [kp-7] 'digit-argument)
2158 (define-key map [kp-8] 'digit-argument)
2159 (define-key map [kp-9] 'digit-argument)
2160 (define-key map [kp-subtract] 'universal-argument-minus)
2161 map)
2164 (defvar universal-argument-num-events nil
2165 "Number of argument-specifying events read by `universal-argument'.
2166 `universal-argument-other-key' uses this to discard those events
2167 from (this-command-keys), and reread only the final command.")
2169 (defvar overriding-map-is-bound nil
2170 "Non-nil when `overriding-terminal-local-map' is `universal-argument-map'.")
2172 (defvar saved-overriding-map nil
2173 "The saved value of `overriding-terminal-local-map'.
2177 (defun ensure-overriding-map-is-bound ()
2178 "Check `overriding-terminal-local-map' is `universal-argument-map'."
2179 (unless overriding-map-is-bound
2180 (setq saved-overriding-map overriding-terminal-local-map)
2181 (setq overriding-terminal-local-map universal-argument-map)
2182 (setq overriding-map-is-bound t)))
2184 (defun restore-overriding-map ()
2185 "Restore `overriding-terminal-local-map' to its saved value."
2186 (setq overriding-terminal-local-map saved-overriding-map)
2187 (setq overriding-map-is-bound nil))
2189 (defun universal-argument ()
2190 "Begin a numeric argument for the following command.
2195 multiplies the argument by 4 each time.
2197 which is different in effect from any particular numeric argument.
2199 (interactive)
2200 (setq prefix-arg (list 4))
2201 (setq universal-argument-num-events (length (this-command-keys)))
2202 (ensure-overriding-map-is-bound))
2204 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
2205 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2206 (defun universal-argument-more (arg)
2207 (interactive "P")
2208 (if (consp arg)
2209 (setq prefix-arg (list (* 4 (car arg))))
2210 (if (eq arg '-)
2211 (setq prefix-arg (list -4))
2212 (setq prefix-arg arg)
2213 (restore-overriding-map)))
2214 (setq universal-argument-num-events (length (this-command-keys))))
2216 (defun negative-argument (arg)
2217 "Begin a negative numeric argument for the next command.
2219 (interactive "P")
2220 (cond ((integerp arg)
2221 (setq prefix-arg (- arg)))
2222 ((eq arg '-)
2223 (setq prefix-arg nil))
2224 (t
2225 (setq prefix-arg '-)))
2226 (setq universal-argument-num-events (length (this-command-keys)))
2227 (ensure-overriding-map-is-bound))
2229 (defun digit-argument (arg)
2230 "Part of the numeric argument for the next command.
2232 (interactive "P")
2233 (let* ((char (if (integerp last-command-char)
2234 last-command-char
2235 (get last-command-char 'ascii-character)))
2237 (cond ((integerp arg)
2238 (setq prefix-arg (+ (* arg 10)
2239 (if (< arg 0) (- digit) digit))))
2240 ((eq arg '-)
2241 ;; Treat -0 as just -, so that -01 will work.
2242 (setq prefix-arg (if (zerop digit) '- (- digit))))
2243 (t
2244 (setq prefix-arg digit))))
2245 (setq universal-argument-num-events (length (this-command-keys)))
2246 (ensure-overriding-map-is-bound))
2248 ;; For backward compatibility, minus with no modifiers is an ordinary
2249 ;; command if digits have already been entered.
2250 (defun universal-argument-minus (arg)
2251 (interactive "P")
2252 (if (integerp arg)
2253 (universal-argument-other-key arg)
2254 (negative-argument arg)))
2256 ;; Anything else terminates the argument and is left in the queue to be
2257 ;; executed as a command.
2258 (defun universal-argument-other-key (arg)
2259 (interactive "P")
2260 (setq prefix-arg arg)
2261 (let* ((key (this-command-keys))
2262 (keylist (listify-key-sequence key)))
2263 (setq unread-command-events
2264 (append (nthcdr universal-argument-num-events keylist)
2265 unread-command-events)))
2266 (reset-this-command-lengths)
2267 (restore-overriding-map))
2268 \f
2269 (defvar buffer-substring-filters nil
2270 "List of filter functions for `filter-buffer-substring'.
2271 Each function must accept a single argument, a string, and return
2272 a string. The buffer substring is passed to the first function
2273 in the list, and the return value of each function is passed to
2274 the next. The return value of the last function is used as the
2275 return value of `filter-buffer-substring'.
2277 If this variable is nil, no filtering is performed.")
2279 (defun filter-buffer-substring (beg end &optional delete)
2280 "Return the buffer substring between BEG and END, after filtering.
2281 The buffer substring is passed through each of the filter
2282 functions in `buffer-substring-filters', and the value from the
2283 last filter function is returned. If `buffer-substring-filters'
2284 is nil, the buffer substring is returned unaltered.
2286 If DELETE is non-nil, the text between BEG and END is deleted
2287 from the buffer.
2289 Point is temporarily set to BEG before calling
2290 `buffer-substring-filters', in case the functions need to know
2291 where the text came from.
2293 This function should be used instead of `buffer-substring' or
2294 `delete-and-extract-region' when you want to allow filtering to
2295 take place. For example, major or minor modes can use
2296 `buffer-substring-filters' to extract characters that are special
2297 to a buffer, and should not be copied into other buffers."
2298 (save-excursion
2299 (goto-char beg)
2300 (let ((string (if delete (delete-and-extract-region beg end)
2301 (buffer-substring beg end))))
2302 (dolist (filter buffer-substring-filters string)
2303 (setq string (funcall filter string))))))
2305 ;;;; Window system cut and paste hooks.
2307 (defvar interprogram-cut-function nil
2308 "Function to call to make a killed region available to other programs.
2310 Most window systems provide some sort of facility for cutting and
2311 pasting text between the windows of different programs.
2312 This variable holds a function that Emacs calls whenever text
2313 is put in the kill ring, to make the new kill available to other
2314 programs.
2316 The function takes one or two arguments.
2317 The first argument, TEXT, is a string containing
2318 the text which should be made available.
2319 The second, optional, argument PUSH, has the same meaning as the
2320 similar argument to `x-set-cut-buffer', which see.")
2322 (defvar interprogram-paste-function nil
2323 "Function to call to get text cut from other programs.
2325 Most window systems provide some sort of facility for cutting and
2326 pasting text between the windows of different programs.
2327 This variable holds a function that Emacs calls to obtain
2328 text that other programs have provided for pasting.
2330 The function should be called with no arguments. If the function
2331 returns nil, then no other program has provided such text, and the top
2332 of the Emacs kill ring should be used. If the function returns a
2333 string, then the caller of the function \(usually `current-kill')
2334 should put this string in the kill ring as the latest kill.
2336 Note that the function should return a string only if a program other
2337 than Emacs has provided a string for pasting; if Emacs provided the
2338 most recent string, the function should return nil. If it is
2339 difficult to tell whether Emacs or some other program provided the
2340 current string, it is probably good enough to return nil if the string
2341 is equal (according to `string=') to the last text Emacs provided.")
2342 \f
2345 ;;;; The kill ring data structure.
2347 (defvar kill-ring nil
2348 "List of killed text sequences.
2349 Since the kill ring is supposed to interact nicely with cut-and-paste
2350 facilities offered by window systems, use of this variable should
2351 interact nicely with `interprogram-cut-function' and
2352 `interprogram-paste-function'. The functions `kill-new',
2353 `kill-append', and `current-kill' are supposed to implement this
2354 interaction; you may want to use them instead of manipulating the kill
2355 ring directly.")
2357 (defcustom kill-ring-max 60
2358 "*Maximum length of kill ring before oldest elements are thrown away."
2359 :type 'integer
2360 :group 'killing)
2362 (defvar kill-ring-yank-pointer nil
2363 "The tail of the kill ring whose car is the last thing yanked.")
2365 (defun kill-new (string &optional replace yank-handler)
2366 "Make STRING the latest kill in the kill ring.
2367 Set `kill-ring-yank-pointer' to point to it.
2368 If `interprogram-cut-function' is non-nil, apply it to STRING.
2369 Optional second argument REPLACE non-nil means that STRING will replace
2370 the front of the kill ring, rather than being added to the list.
2372 Optional third arguments YANK-HANDLER controls how the STRING is later
2373 inserted into a buffer; see `insert-for-yank' for details.
2374 When a yank handler is specified, STRING must be non-empty (the yank
2375 handler, if non-nil, is stored as a `yank-handler' text property on STRING).
2377 When the yank handler has a non-nil PARAM element, the original STRING
2378 argument is not used by `insert-for-yank'. However, since Lisp code
2379 may access and use elements from the kill ring directly, the STRING
2381 (if (> (length string) 0)
2382 (if yank-handler
2383 (put-text-property 0 (length string)
2384 'yank-handler yank-handler string))
2385 (if yank-handler
2386 (signal 'args-out-of-range
2387 (list string "yank-handler specified for empty string"))))
2388 (if (fboundp 'menu-bar-update-yank-menu)
2389 (menu-bar-update-yank-menu string (and replace (car kill-ring))))
2390 (if (and replace kill-ring)
2391 (setcar kill-ring string)
2392 (setq kill-ring (cons string kill-ring))
2393 (if (> (length kill-ring) kill-ring-max)
2394 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil)))
2395 (setq kill-ring-yank-pointer kill-ring)
2396 (if interprogram-cut-function
2397 (funcall interprogram-cut-function string (not replace))))
2399 (defun kill-append (string before-p &optional yank-handler)
2400 "Append STRING to the end of the latest kill in the kill ring.
2401 If BEFORE-P is non-nil, prepend STRING to the kill.
2402 Optional third argument YANK-HANDLER, if non-nil, specifies the
2403 yank-handler text property to be set on the combined kill ring
2404 string. If the specified yank-handler arg differs from the
2405 yank-handler property of the latest kill string, this function
2406 adds the combined string to the kill ring as a new element,
2407 instead of replacing the last kill with it.
2408 If `interprogram-cut-function' is set, pass the resulting kill to it."
2409 (let* ((cur (car kill-ring)))
2410 (kill-new (if before-p (concat string cur) (concat cur string))
2411 (or (= (length cur) 0)
2412 (equal yank-handler (get-text-property 0 'yank-handler cur)))
2413 yank-handler)))
2415 (defun current-kill (n &optional do-not-move)
2416 "Rotate the yanking point by N places, and then return that kill.
2417 If N is zero, `interprogram-paste-function' is set, and calling it
2418 returns a string, then that string is added to the front of the
2419 kill ring and returned as the latest kill.
2420 If optional arg DO-NOT-MOVE is non-nil, then don't actually move the
2421 yanking point; just return the Nth kill forward."
2422 (let ((interprogram-paste (and (= n 0)
2423 interprogram-paste-function
2424 (funcall interprogram-paste-function))))
2425 (if interprogram-paste
2426 (progn
2427 ;; Disable the interprogram cut function when we add the new
2428 ;; text to the kill ring, so Emacs doesn't try to own the
2429 ;; selection, with identical text.
2430 (let ((interprogram-cut-function nil))
2431 (kill-new interprogram-paste))
2432 interprogram-paste)
2433 (or kill-ring (error "Kill ring is empty"))
2434 (let ((ARGth-kill-element
2435 (nthcdr (mod (- n (length kill-ring-yank-pointer))
2436 (length kill-ring))
2437 kill-ring)))
2438 (or do-not-move
2439 (setq kill-ring-yank-pointer ARGth-kill-element))
2440 (car ARGth-kill-element)))))
2444 ;;;; Commands for manipulating the kill ring.
2446 (defcustom kill-read-only-ok nil
2447 "*Non-nil means don't signal an error for killing read-only text."
2448 :type 'boolean
2449 :group 'killing)
2451 (put 'text-read-only 'error-conditions
2452 '(text-read-only buffer-read-only error))
2453 (put 'text-read-only 'error-message "Text is read-only")
2455 (defun kill-region (beg end &optional yank-handler)
2456 "Kill between point and mark.
2457 The text is deleted but saved in the kill ring.
2461 If you want to append the killed region to the last killed text,
2464 If the buffer is read-only, Emacs will beep and refrain from deleting
2465 the text, but put the text in the kill ring anyway. This means that
2466 you can use the killing commands to copy text from a read-only buffer.
2468 This is the primitive for programs to kill text (as opposed to deleting it).
2469 Supply two arguments, character positions indicating the stretch of text
2470 to be killed.
2472 If the previous command was also a kill command,
2473 the text killed this time appends to the text killed last time
2474 to make one entry in the kill ring.
2476 In Lisp code, optional third arg YANK-HANDLER, if non-nil,
2477 specifies the yank-handler text property to be set on the killed
2478 text. See `insert-for-yank'."
2479 (interactive "r")
2480 (condition-case nil
2481 (let ((string (filter-buffer-substring beg end t)))
2482 (when string ;STRING is nil if BEG = END
2483 ;; Add that string to the kill ring, one way or another.
2484 (if (eq last-command 'kill-region)
2485 (kill-append string (< end beg) yank-handler)
2486 (kill-new string nil yank-handler)))
2487 (when (or string (eq last-command 'kill-region))
2488 (setq this-command 'kill-region))
2489 nil)
2490 ((buffer-read-only text-read-only)
2491 ;; The code above failed because the buffer, or some of the characters
2492 ;; in the region, are read-only.
2493 ;; We should beep, in case the user just isn't aware of this.
2494 ;; However, there's no harm in putting
2495 ;; the region's text in the kill ring, anyway.
2496 (copy-region-as-kill beg end)
2497 ;; Set this-command now, so it will be set even if we get an error.
2498 (setq this-command 'kill-region)
2499 ;; This should barf, if appropriate, and give us the correct error.
2500 (if kill-read-only-ok
2501 (progn (message "Read only text copied to kill ring") nil)
2502 ;; Signal an error if the buffer is read-only.
2503 (barf-if-buffer-read-only)
2504 ;; If the buffer isn't read-only, the text is.
2505 (signal 'text-read-only (list (current-buffer)))))))
2507 ;; copy-region-as-kill no longer sets this-command, because it's confusing
2508 ;; to get two copies of the text when the user accidentally types M-w and
2509 ;; then corrects it with the intended C-w.
2510 (defun copy-region-as-kill (beg end)
2511 "Save the region as if killed, but don't kill it.
2512 In Transient Mark mode, deactivate the mark.
2513 If `interprogram-cut-function' is non-nil, also save the text for a window
2514 system cut and paste."
2515 (interactive "r")
2516 (if (eq last-command 'kill-region)
2517 (kill-append (filter-buffer-substring beg end) (< end beg))
2518 (kill-new (filter-buffer-substring beg end)))
2519 (if transient-mark-mode
2520 (setq deactivate-mark t))
2521 nil)
2523 (defun kill-ring-save (beg end)
2524 "Save the region as if killed, but don't kill it.
2525 In Transient Mark mode, deactivate the mark.
2526 If `interprogram-cut-function' is non-nil, also save the text for a window
2527 system cut and paste.
2529 If you want to append the killed line to the last killed text,
2532 This command is similar to `copy-region-as-kill', except that it gives
2533 visual feedback indicating the extent of the region being copied."
2534 (interactive "r")
2535 (copy-region-as-kill beg end)
2536 ;; This use of interactive-p is correct
2537 ;; because the code it controls just gives the user visual feedback.
2538 (if (interactive-p)
2539 (let ((other-end (if (= (point) beg) end beg))
2540 (opoint (point))
2541 ;; Inhibit quitting so we can make a quit here
2542 ;; look like a C-g typed as a command.
2543 (inhibit-quit t))
2544 (if (pos-visible-in-window-p other-end (selected-window))
2545 (unless (and transient-mark-mode
2546 (face-background 'region))
2547 ;; Swap point and mark.
2548 (set-marker (mark-marker) (point) (current-buffer))
2549 (goto-char other-end)
2550 (sit-for blink-matching-delay)
2551 ;; Swap back.
2552 (set-marker (mark-marker) other-end (current-buffer))
2553 (goto-char opoint)
2554 ;; If user quit, deactivate the mark
2555 ;; as C-g would as a command.
2556 (and quit-flag mark-active
2557 (deactivate-mark)))
2558 (let* ((killed-text (current-kill 0))
2559 (message-len (min (length killed-text) 40)))
2560 (if (= (point) beg)
2561 ;; Don't say "killed"; that is misleading.
2563 (substring killed-text (- message-len)))
2565 (substring killed-text 0 message-len))))))))
2567 (defun append-next-kill (&optional interactive)
2568 "Cause following command, if it kills, to append to previous kill.
2569 The argument is used for internal purposes; do not supply one."
2570 (interactive "p")
2571 ;; We don't use (interactive-p), since that breaks kbd macros.
2572 (if interactive
2573 (progn
2574 (setq this-command 'kill-region)
2575 (message "If the next command is a kill, it will append"))
2576 (setq last-command 'kill-region)))
2577 \f
2578 ;; Yanking.
2580 ;; This is actually used in subr.el but defcustom does not work there.
2581 (defcustom yank-excluded-properties
2582 '(read-only invisible intangible field mouse-face help-echo local-map keymap
2583 yank-handler follow-link)
2584 "*Text properties to discard when yanking.
2585 The value should be a list of text properties to discard or t,
2586 which means to discard all text properties."
2587 :type '(choice (const :tag "All" t) (repeat symbol))
2588 :group 'killing
2589 :version "22.1")
2591 (defvar yank-window-start nil)
2592 (defvar yank-undo-function nil
2593 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
2594 Function is called with two parameters, START and END corresponding to
2595 the value of the mark and point; it is guaranteed that START <= END.
2596 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
2598 (defun yank-pop (&optional arg)
2599 "Replace just-yanked stretch of killed text with a different stretch.
2600 This command is allowed only immediately after a `yank' or a `yank-pop'.
2601 At such a time, the region contains a stretch of reinserted
2602 previously-killed text. `yank-pop' deletes that text and inserts in its
2603 place a different stretch of killed text.
2605 With no argument, the previous kill is inserted.
2606 With argument N, insert the Nth previous kill.
2607 If N is negative, this is a more recent kill.
2609 The sequence of kills wraps around, so that after the oldest one
2610 comes the newest one.
2612 When this command inserts killed text into the buffer, it honors
2613 `yank-excluded-properties' and `yank-handler' as described in the
2614 doc string for `insert-for-yank-1', which see."
2615 (interactive "*p")
2616 (if (not (eq last-command 'yank))
2617 (error "Previous command was not a yank"))
2618 (setq this-command 'yank)
2619 (unless arg (setq arg 1))
2620 (let ((inhibit-read-only t)
2621 (before (< (point) (mark t))))
2622 (if before
2623 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
2624 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
2625 (setq yank-undo-function nil)
2626 (set-marker (mark-marker) (point) (current-buffer))
2627 (insert-for-yank (current-kill arg))
2628 ;; Set the window start back where it was in the yank command,
2629 ;; if possible.
2630 (set-window-start (selected-window) yank-window-start t)
2631 (if before
2632 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
2633 ;; It is cleaner to avoid activation, even though the command
2634 ;; loop would deactivate the mark because we inserted text.
2635 (goto-char (prog1 (mark t)
2636 (set-marker (mark-marker) (point) (current-buffer))))))
2637 nil)
2639 (defun yank (&optional arg)
2640 "Reinsert the last stretch of killed text.
2641 More precisely, reinsert the stretch of killed text most recently
2642 killed OR yanked. Put point at end, and set mark at beginning.
2643 With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
2644 With argument N, reinsert the Nth most recently killed stretch of killed
2645 text.
2647 When this command inserts killed text into the buffer, it honors
2648 `yank-excluded-properties' and `yank-handler' as described in the
2649 doc string for `insert-for-yank-1', which see.
2652 (interactive "*P")
2653 (setq yank-window-start (window-start))
2654 ;; If we don't get all the way thru, make last-command indicate that
2655 ;; for the following command.
2656 (setq this-command t)
2657 (push-mark (point))
2658 (insert-for-yank (current-kill (cond
2659 ((listp arg) 0)
2660 ((eq arg '-) -2)
2661 (t (1- arg)))))
2662 (if (consp arg)
2663 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
2664 ;; It is cleaner to avoid activation, even though the command
2665 ;; loop would deactivate the mark because we inserted text.
2666 (goto-char (prog1 (mark t)
2667 (set-marker (mark-marker) (point) (current-buffer)))))
2668 ;; If we do get all the way thru, make this-command indicate that.
2669 (if (eq this-command t)
2670 (setq this-command 'yank))
2671 nil)
2673 (defun rotate-yank-pointer (arg)
2674 "Rotate the yanking point in the kill ring.
2675 With argument, rotate that many kills forward (or backward, if negative)."
2676 (interactive "p")
2677 (current-kill arg))
2678 \f
2679 ;; Some kill commands.
2681 ;; Internal subroutine of delete-char
2682 (defun kill-forward-chars (arg)
2683 (if (listp arg) (setq arg (car arg)))
2684 (if (eq arg '-) (setq arg -1))
2685 (kill-region (point) (forward-point arg)))
2687 ;; Internal subroutine of backward-delete-char
2688 (defun kill-backward-chars (arg)
2689 (if (listp arg) (setq arg (car arg)))
2690 (if (eq arg '-) (setq arg -1))
2691 (kill-region (point) (forward-point (- arg))))
2693 (defcustom backward-delete-char-untabify-method 'untabify
2694 "*The method for untabifying when deleting backward.
2695 Can be `untabify' -- turn a tab to many spaces, then delete one space;
2696 `hungry' -- delete all whitespace, both tabs and spaces;
2697 `all' -- delete all whitespace, including tabs, spaces and newlines;
2698 nil -- just delete one character."
2699 :type '(choice (const untabify) (const hungry) (const all) (const nil))
2700 :version "20.3"
2701 :group 'killing)
2703 (defun backward-delete-char-untabify (arg &optional killp)
2704 "Delete characters backward, changing tabs into spaces.
2705 The exact behavior depends on `backward-delete-char-untabify-method'.
2706 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
2707 Interactively, ARG is the prefix arg (default 1)
2708 and KILLP is t if a prefix arg was specified."
2710 (when (eq backward-delete-char-untabify-method 'untabify)
2711 (let ((count arg))
2712 (save-excursion
2713 (while (and (> count 0) (not (bobp)))
2715 (let ((col (current-column)))
2716 (forward-char -1)
2717 (setq col (- col (current-column)))
2718 (insert-char ?\s col)
2719 (delete-char 1)))
2720 (forward-char -1)
2721 (setq count (1- count))))))
2722 (delete-backward-char
2724 ((eq backward-delete-char-untabify-method 'all)
2726 (if skip
2727 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
2728 (point)))))
2729 (+ arg (if (zerop wh) 0 (1- wh))))
2730 arg))
2731 killp))
2733 (defun zap-to-char (arg char)
2734 "Kill up to and including ARG'th occurrence of CHAR.
2735 Case is ignored if `case-fold-search' is non-nil in the current buffer.
2736 Goes backward if ARG is negative; error if CHAR not found."
2738 (kill-region (point) (progn
2739 (search-forward (char-to-string char) nil nil arg)
2740 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
2741 (point))))
2743 ;; kill-line and its subroutines.
2745 (defcustom kill-whole-line nil
2746 "*If non-nil, `kill-line' with no arg at beg of line kills the whole line."
2747 :type 'boolean
2748 :group 'killing)
2750 (defun kill-line (&optional arg)
2751 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
2752 With prefix argument, kill that many lines from point.
2753 Negative arguments kill lines backward.
2754 With zero argument, kills the text before point on the current line.
2757 a number counts as a prefix arg.
2759 To kill a whole line, when point is not at the beginning, type \
2762 If `kill-whole-line' is non-nil, then this command kills the whole line
2763 including its terminating newline, when used at the beginning of a line
2764 with no argument. As a consequence, you can always kill a whole line
2767 If you want to append the killed line to the last killed text,
2770 If the buffer is read-only, Emacs will beep and refrain from deleting
2771 the line, but put the line in the kill ring anyway. This means that
2772 you can use this command to copy text from a read-only buffer.
2773 \(If the variable `kill-read-only-ok' is non-nil, then this won't
2774 even beep.)"
2775 (interactive "P")
2776 (kill-region (point)
2777 ;; It is better to move point to the other end of the kill
2778 ;; before killing. That way, in a read-only buffer, point
2779 ;; moves across the text that is copied to the kill ring.
2780 ;; The choice has no effect on undo now that undo records
2781 ;; the value of point from before the command was run.
2782 (progn
2783 (if arg
2784 (forward-visible-line (prefix-numeric-value arg))
2785 (if (eobp)
2786 (signal 'end-of-buffer nil))
2787 (let ((end
2788 (save-excursion
2789 (end-of-visible-line) (point))))
2790 (if (or (save-excursion
2791 ;; If trailing whitespace is visible,
2792 ;; don't treat it as nothing.
2793 (unless show-trailing-whitespace
2795 (= (point) end))
2796 (and kill-whole-line (bolp)))
2797 (forward-visible-line 1)
2798 (goto-char end))))
2799 (point))))
2801 (defun kill-whole-line (&optional arg)
2802 "Kill current line.
2803 With prefix arg, kill that many lines starting from the current line.
2804 If arg is negative, kill backward. Also kill the preceding newline.
2806 If arg is zero, kill current line but exclude the trailing newline."
2807 (interactive "p")
2808 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
2809 (signal 'end-of-buffer nil))
2810 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
2811 (signal 'beginning-of-buffer nil))
2812 (unless (eq last-command 'kill-region)
2813 (kill-new "")
2814 (setq last-command 'kill-region))
2815 (cond ((zerop arg)
2816 ;; We need to kill in two steps, because the previous command
2817 ;; could have been a kill command, in which case the text
2818 ;; before point needs to be prepended to the current kill
2819 ;; ring entry and the text after point appended. Also, we
2820 ;; need to use save-excursion to avoid copying the same text
2821 ;; twice to the kill ring in read-only buffers.
2822 (save-excursion
2823 (kill-region (point) (progn (forward-visible-line 0) (point))))
2824 (kill-region (point) (progn (end-of-visible-line) (point))))
2825 ((< arg 0)
2826 (save-excursion
2827 (kill-region (point) (progn (end-of-visible-line) (point))))
2828 (kill-region (point)
2829 (progn (forward-visible-line (1+ arg))
2830 (unless (bobp) (backward-char))
2831 (point))))
2832 (t
2833 (save-excursion
2834 (kill-region (point) (progn (forward-visible-line 0) (point))))
2835 (kill-region (point)
2836 (progn (forward-visible-line arg) (point))))))
2838 (defun forward-visible-line (arg)
2839 "Move forward by ARG lines, ignoring currently invisible newlines only.
2840 If ARG is negative, move backward -ARG lines.
2841 If ARG is zero, move to the beginning of the current line."
2842 (condition-case nil
2843 (if (> arg 0)
2844 (progn
2845 (while (> arg 0)
2846 (or (zerop (forward-line 1))
2847 (signal 'end-of-buffer nil))
2848 ;; If the newline we just skipped is invisible,
2849 ;; don't count it.
2850 (let ((prop
2851 (get-char-property (1- (point)) 'invisible)))
2852 (if (if (eq buffer-invisibility-spec t)
2853 prop
2854 (or (memq prop buffer-invisibility-spec)
2855 (assq prop buffer-invisibility-spec)))
2856 (setq arg (1+ arg))))
2857 (setq arg (1- arg)))
2858 ;; If invisible text follows, and it is a number of complete lines,
2859 ;; skip it.
2860 (let ((opoint (point)))
2861 (while (and (not (eobp))
2862 (let ((prop
2863 (get-char-property (point) 'invisible)))
2864 (if (eq buffer-invisibility-spec t)
2865 prop
2866 (or (memq prop buffer-invisibility-spec)
2867 (assq prop buffer-invisibility-spec)))))
2868 (goto-char
2869 (if (get-text-property (point) 'invisible)
2870 (or (next-single-property-change (point) 'invisible)
2871 (point-max))
2872 (next-overlay-change (point)))))
2873 (unless (bolp)
2874 (goto-char opoint))))
2875 (let ((first t))
2876 (while (or first (<= arg 0))
2877 (if first
2878 (beginning-of-line)
2879 (or (zerop (forward-line -1))
2880 (signal 'beginning-of-buffer nil)))
2881 ;; If the newline we just moved to is invisible,
2882 ;; don't count it.
2883 (unless (bobp)
2884 (let ((prop
2885 (get-char-property (1- (point)) 'invisible)))
2886 (unless (if (eq buffer-invisibility-spec t)
2887 prop
2888 (or (memq prop buffer-invisibility-spec)
2889 (assq prop buffer-invisibility-spec)))
2890 (setq arg (1+ arg)))))
2891 (setq first nil))
2892 ;; If invisible text follows, and it is a number of complete lines,
2893 ;; skip it.
2894 (let ((opoint (point)))
2895 (while (and (not (bobp))
2896 (let ((prop
2897 (get-char-property (1- (point)) 'invisible)))
2898 (if (eq buffer-invisibility-spec t)
2899 prop
2900 (or (memq prop buffer-invisibility-spec)
2901 (assq prop buffer-invisibility-spec)))))
2902 (goto-char
2903 (if (get-text-property (1- (point)) 'invisible)
2904 (or (previous-single-property-change (point) 'invisible)
2905 (point-min))
2906 (previous-overlay-change (point)))))
2907 (unless (bolp)
2908 (goto-char opoint)))))
2909 ((beginning-of-buffer end-of-buffer)
2910 nil)))
2912 (defun end-of-visible-line ()
2913 "Move to end of current visible line."
2914 (end-of-line)
2915 ;; If the following character is currently invisible,
2916 ;; skip all characters with that same `invisible' property value,
2917 ;; then find the next newline.
2918 (while (and (not (eobp))
2919 (save-excursion
2921 (let ((prop
2922 (get-char-property (point) 'invisible)))
2923 (if (eq buffer-invisibility-spec t)
2924 prop
2925 (or (memq prop buffer-invisibility-spec)
2926 (assq prop buffer-invisibility-spec))))))
2928 (if (get-text-property (point) 'invisible)
2929 (goto-char (next-single-property-change (point) 'invisible))
2930 (goto-char (next-overlay-change (point))))
2931 (end-of-line)))
2932 \f
2933 (defun insert-buffer (buffer)
2934 "Insert after point the contents of BUFFER.
2935 Puts mark after the inserted text.
2936 BUFFER may be a buffer or a buffer name.
2938 This function is meant for the user to run interactively.
2939 Don't call it from programs: use `insert-buffer-substring' instead!"
2940 (interactive
2941 (list
2942 (progn
2943 (barf-if-buffer-read-only)
2944 (read-buffer "Insert buffer: "
2945 (if (eq (selected-window) (next-window (selected-window)))
2946 (other-buffer (current-buffer))
2947 (window-buffer (next-window (selected-window))))
2948 t))))
2949 (push-mark
2950 (save-excursion
2951 (insert-buffer-substring (get-buffer buffer))
2952 (point)))
2953 nil)
2955 (defun append-to-buffer (buffer start end)
2956 "Append to specified buffer the text of the region.
2957 It is inserted into that buffer before its point.
2959 When calling from a program, give three arguments:
2960 BUFFER (or buffer name), START and END.
2961 START and END specify the portion of the current buffer to be copied."
2962 (interactive
2963 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
2964 (region-beginning) (region-end)))
2965 (let ((oldbuf (current-buffer)))
2966 (save-excursion
2967 (let* ((append-to (get-buffer-create buffer))
2968 (windows (get-buffer-window-list append-to t t))
2969 point)
2970 (set-buffer append-to)
2971 (setq point (point))
2972 (barf-if-buffer-read-only)
2973 (insert-buffer-substring oldbuf start end)
2974 (dolist (window windows)
2975 (when (= (window-point window) point)
2976 (set-window-point window (point))))))))
2978 (defun prepend-to-buffer (buffer start end)
2979 "Prepend to specified buffer the text of the region.
2980 It is inserted into that buffer after its point.
2982 When calling from a program, give three arguments:
2983 BUFFER (or buffer name), START and END.
2984 START and END specify the portion of the current buffer to be copied."
2986 (let ((oldbuf (current-buffer)))
2987 (save-excursion
2988 (set-buffer (get-buffer-create buffer))
2989 (barf-if-buffer-read-only)
2990 (save-excursion
2991 (insert-buffer-substring oldbuf start end)))))
2993 (defun copy-to-buffer (buffer start end)
2994 "Copy to specified buffer the text of the region.
2995 It is inserted into that buffer, replacing existing text there.
2997 When calling from a program, give three arguments:
2998 BUFFER (or buffer name), START and END.
2999 START and END specify the portion of the current buffer to be copied."
3001 (let ((oldbuf (current-buffer)))
3002 (save-excursion
3003 (set-buffer (get-buffer-create buffer))
3004 (barf-if-buffer-read-only)
3005 (erase-buffer)
3006 (save-excursion
3007 (insert-buffer-substring oldbuf start end)))))
3008 \f
3009 (put 'mark-inactive 'error-conditions '(mark-inactive error))
3010 (put 'mark-inactive 'error-message "The mark is not active now")
3012 (defvar activate-mark-hook nil
3013 "Hook run when the mark becomes active.
3014 It is also run at the end of a command, if the mark is active and
3015 it is possible that the region may have changed")
3017 (defvar deactivate-mark-hook nil
3018 "Hook run when the mark becomes inactive.")
3020 (defun mark (&optional force)
3021 "Return this buffer's mark value as integer; error if mark inactive.
3022 If optional argument FORCE is non-nil, access the mark value
3023 even if the mark is not currently active, and return nil
3024 if there is no mark at all.
3026 If you are using this in an editing command, you are most likely making
3027 a mistake; see the documentation of `set-mark'."
3028 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
3029 (marker-position (mark-marker))
3030 (signal 'mark-inactive nil)))
3032 ;; Many places set mark-active directly, and several of them failed to also
3033 ;; run deactivate-mark-hook. This shorthand should simplify.
3034 (defsubst deactivate-mark ()
3035 "Deactivate the mark by setting `mark-active' to nil.
3036 \(That makes a difference only in Transient Mark mode.)
3037 Also runs the hook `deactivate-mark-hook'."
3038 (cond
3039 ((eq transient-mark-mode 'lambda)
3040 (setq transient-mark-mode nil))
3041 (transient-mark-mode
3042 (setq mark-active nil)
3043 (run-hooks 'deactivate-mark-hook))))
3045 (defun set-mark (pos)
3046 "Set this buffer's mark to POS. Don't use this function!
3047 That is to say, don't use this function unless you want
3048 the user to see that the mark has moved, and you want the previous
3049 mark position to be lost.
3051 Normally, when a new mark is set, the old one should go on the stack.
3052 This is why most applications should use `push-mark', not `set-mark'.
3054 Novice Emacs Lisp programmers often try to use the mark for the wrong
3055 purposes. The mark saves a location for the user's convenience.
3056 Most editing commands should not alter the mark.
3057 To remember a location for internal use in the Lisp program,
3058 store it in a Lisp variable. Example:
3060 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
3062 (if pos
3063 (progn
3064 (setq mark-active t)
3065 (run-hooks 'activate-mark-hook)
3066 (set-marker (mark-marker) pos (current-buffer)))
3067 ;; Normally we never clear mark-active except in Transient Mark mode.
3068 ;; But when we actually clear out the mark value too,
3069 ;; we must clear mark-active in any mode.
3070 (setq mark-active nil)
3071 (run-hooks 'deactivate-mark-hook)
3072 (set-marker (mark-marker) nil)))
3074 (defvar mark-ring nil
3075 "The list of former marks of the current buffer, most recent first.")
3076 (make-variable-buffer-local 'mark-ring)
3077 (put 'mark-ring 'permanent-local t)
3079 (defcustom mark-ring-max 16
3080 "*Maximum size of mark ring. Start discarding off end if gets this big."
3081 :type 'integer
3082 :group 'editing-basics)
3084 (defvar global-mark-ring nil
3085 "The list of saved global marks, most recent first.")
3087 (defcustom global-mark-ring-max 16
3088 "*Maximum size of global mark ring. \
3089 Start discarding off end if gets this big."
3090 :type 'integer
3091 :group 'editing-basics)
3093 (defun pop-to-mark-command ()
3094 "Jump to mark, and pop a new position for mark off the ring
3095 \(does not affect global mark ring\)."
3096 (interactive)
3097 (if (null (mark t))
3098 (error "No mark set in this buffer")
3099 (goto-char (mark t))
3100 (pop-mark)))
3102 (defun push-mark-command (arg &optional nomsg)
3103 "Set mark at where point is.
3104 If no prefix arg and mark is already set there, just activate it.
3105 Display `Mark set' unless the optional second arg NOMSG is non-nil."
3106 (interactive "P")
3107 (let ((mark (marker-position (mark-marker))))
3108 (if (or arg (null mark) (/= mark (point)))
3109 (push-mark nil nomsg t)
3110 (setq mark-active t)
3111 (run-hooks 'activate-mark-hook)
3112 (unless nomsg
3113 (message "Mark activated")))))
3115 (defun set-mark-command (arg)
3116 "Set mark at where point is, or jump to mark.
3117 With no prefix argument, set mark, and push old mark position on local
3118 mark ring; also push mark on global mark ring if last mark was set in
3119 another buffer. Immediately repeating the command activates
3120 `transient-mark-mode' temporarily.
3123 jump to mark, and pop a new position
3124 for mark off the local mark ring \(this does not affect the global
3126 mark ring \(see `pop-global-mark'\).
3129 the next position off the local (or global) mark ring.
3133 set mark where point is.
3135 Novice Emacs Lisp programmers often try to use the mark for the wrong
3136 purposes. See the documentation of `set-mark' for more information."
3137 (interactive "P")
3138 (if (eq transient-mark-mode 'lambda)
3139 (setq transient-mark-mode nil))
3140 (cond
3141 ((and (consp arg) (> (prefix-numeric-value arg) 4))
3142 (push-mark-command nil))
3143 ((not (eq this-command 'set-mark-command))
3144 (if arg
3145 (pop-to-mark-command)
3146 (push-mark-command t)))
3147 ((eq last-command 'pop-to-mark-command)
3148 (setq this-command 'pop-to-mark-command)
3149 (pop-to-mark-command))
3150 ((and (eq last-command 'pop-global-mark) (not arg))
3151 (setq this-command 'pop-global-mark)
3152 (pop-global-mark))
3153 (arg
3154 (setq this-command 'pop-to-mark-command)
3155 (pop-to-mark-command))
3156 ((and (eq last-command 'set-mark-command)
3157 mark-active (null transient-mark-mode))
3158 (setq transient-mark-mode 'lambda)
3159 (message "Transient-mark-mode temporarily enabled"))
3160 (t
3161 (push-mark-command nil))))
3163 (defun push-mark (&optional location nomsg activate)
3164 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
3165 If the last global mark pushed was not in the current buffer,
3166 also push LOCATION on the global mark ring.
3167 Display `Mark set' unless the optional second arg NOMSG is non-nil.
3168 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil.
3170 Novice Emacs Lisp programmers often try to use the mark for the wrong
3171 purposes. See the documentation of `set-mark' for more information.
3173 In Transient Mark mode, this does not activate the mark."
3174 (unless (null (mark t))
3175 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
3176 (when (> (length mark-ring) mark-ring-max)
3177 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
3178 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
3179 (set-marker (mark-marker) (or location (point)) (current-buffer))
3180 ;; Now push the mark on the global mark ring.
3181 (if (and global-mark-ring
3182 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
3183 ;; The last global mark pushed was in this same buffer.
3184 ;; Don't push another one.
3185 nil
3186 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
3187 (when (> (length global-mark-ring) global-mark-ring-max)
3188 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
3189 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
3190 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
3191 (message "Mark set"))
3192 (if (or activate (not transient-mark-mode))
3193 (set-mark (mark t)))
3194 nil)
3196 (defun pop-mark ()
3197 "Pop off mark ring into the buffer's actual mark.
3198 Does not set point. Does nothing if mark ring is empty."
3199 (when mark-ring
3200 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
3201 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
3202 (move-marker (car mark-ring) nil)
3203 (if (null (mark t)) (ding))
3204 (setq mark-ring (cdr mark-ring)))
3205 (deactivate-mark))
3207 (defalias 'exchange-dot-and-mark 'exchange-point-and-mark)
3208 (defun exchange-point-and-mark (&optional arg)
3209 "Put the mark where point is now, and point where the mark is now.
3210 This command works even when the mark is not active,
3211 and it reactivates the mark.
3212 With prefix arg, `transient-mark-mode' is enabled temporarily."
3213 (interactive "P")
3214 (if arg
3215 (if mark-active
3216 (if (null transient-mark-mode)
3217 (setq transient-mark-mode 'lambda))
3218 (setq arg nil)))
3219 (unless arg
3220 (let ((omark (mark t)))
3221 (if (null omark)
3222 (error "No mark set in this buffer"))
3223 (set-mark (point))
3224 (goto-char omark)
3225 nil)))
3227 (define-minor-mode transient-mark-mode
3228 "Toggle Transient Mark mode.
3229 With arg, turn Transient Mark mode on if arg is positive, off otherwise.
3231 In Transient Mark mode, when the mark is active, the region is highlighted.
3233 So do certain other operations that set the mark
3234 but whose main purpose is something else--for example,
3240 Many commands change their behavior when Transient Mark mode is in effect
3241 and the mark is active, by acting on the region instead of their usual
3242 default part of the buffer's text. Examples of such commands include
3247 commands which are sensitive to the Transient Mark mode."
3248 :global t :group 'editing-basics :require nil)
3250 (defvar widen-automatically t
3251 "Non-nil means it is ok for commands to call `widen' when they want to.
3252 Some commands will do this in order to go to positions outside
3253 the current accessible part of the buffer.
3255 If `widen-automatically' is nil, these commands will do something else
3256 as a fallback, and won't change the buffer bounds.")
3258 (defun pop-global-mark ()
3259 "Pop off global mark ring and jump to the top location."
3260 (interactive)
3261 ;; Pop entries which refer to non-existent buffers.
3262 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
3263 (setq global-mark-ring (cdr global-mark-ring)))
3264 (or global-mark-ring
3265 (error "No global mark set"))
3266 (let* ((marker (car global-mark-ring))
3267 (buffer (marker-buffer marker))
3268 (position (marker-position marker)))
3269 (setq global-mark-ring (nconc (cdr global-mark-ring)
3270 (list (car global-mark-ring))))
3271 (set-buffer buffer)
3272 (or (and (>= position (point-min))
3273 (<= position (point-max)))
3274 (if widen-automatically
3275 (widen)
3276 (error "Global mark position is outside accessible part of buffer")))
3277 (goto-char position)
3278 (switch-to-buffer buffer)))
3279 \f
3280 (defcustom next-line-add-newlines nil
3281 "*If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
3282 :type 'boolean
3283 :version "21.1"
3284 :group 'editing-basics)
3286 (defun next-line (&optional arg try-vscroll)
3287 "Move cursor vertically down ARG lines.
3288 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
3289 If there is no character in the target line exactly under the current column,
3290 the cursor is positioned after the character in that line which spans this
3291 column, or at the end of the line if it is not long enough.
3292 If there is no line in the buffer after this one, behavior depends on the
3293 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
3294 to create a line, and moves the cursor to that line. Otherwise it moves the
3295 cursor to the end of the buffer.
3298 a semipermanent goal column for this command.
3299 Then instead of trying to move exactly vertically (or as close as possible),
3300 this command moves to the specified goal column (or as close as possible).
3301 The goal column is stored in the variable `goal-column', which is nil
3302 when there is no goal column.
3304 If you are thinking of using this in a Lisp program, consider
3305 using `forward-line' instead. It is usually easier to use
3306 and more reliable (no dependence on goal column, etc.)."
3308 (or arg (setq arg 1))
3309 (if (and next-line-add-newlines (= arg 1))
3310 (if (save-excursion (end-of-line) (eobp))
3311 ;; When adding a newline, don't expand an abbrev.
3312 (let ((abbrev-mode nil))
3313 (end-of-line)
3315 (line-move arg nil nil try-vscroll))
3316 (if (interactive-p)
3317 (condition-case nil
3318 (line-move arg nil nil try-vscroll)
3319 ((beginning-of-buffer end-of-buffer) (ding)))
3320 (line-move arg nil nil try-vscroll)))
3321 nil)
3323 (defun previous-line (&optional arg try-vscroll)
3324 "Move cursor vertically up ARG lines.
3325 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
3326 If there is no character in the target line exactly over the current column,
3327 the cursor is positioned after the character in that line which spans this
3328 column, or at the end of the line if it is not long enough.
3331 a semipermanent goal column for this command.
3332 Then instead of trying to move exactly vertically (or as close as possible),
3333 this command moves to the specified goal column (or as close as possible).
3334 The goal column is stored in the variable `goal-column', which is nil
3335 when there is no goal column.
3337 If you are thinking of using this in a Lisp program, consider using
3338 `forward-line' with a negative argument instead. It is usually easier
3339 to use and more reliable (no dependence on goal column, etc.)."
3341 (or arg (setq arg 1))
3342 (if (interactive-p)
3343 (condition-case nil
3344 (line-move (- arg) nil nil try-vscroll)
3345 ((beginning-of-buffer end-of-buffer) (ding)))
3346 (line-move (- arg) nil nil try-vscroll))
3347 nil)
3349 (defcustom track-eol nil
3350 "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
3351 This means moving to the end of each line moved onto.
3352 The beginning of a blank line does not count as the end of a line."
3353 :type 'boolean
3354 :group 'editing-basics)
3356 (defcustom goal-column nil
3358 :type '(choice integer
3359 (const :tag "None" nil))
3360 :group 'editing-basics)
3361 (make-variable-buffer-local 'goal-column)
3363 (defvar temporary-goal-column 0
3364 "Current goal column for vertical motion.
3365 It is the column where point was
3366 at the start of current run of vertical motion commands.
3367 When the `track-eol' feature is doing its job, the value is 9999.")
3369 (defcustom line-move-ignore-invisible t
3371 Outline mode sets this."
3372 :type 'boolean
3373 :group 'editing-basics)
3375 (defun line-move-invisible-p (pos)
3376 "Return non-nil if the character after POS is currently invisible."
3377 (let ((prop
3378 (get-char-property pos 'invisible)))
3379 (if (eq buffer-invisibility-spec t)
3380 prop
3381 (or (memq prop buffer-invisibility-spec)
3382 (assq prop buffer-invisibility-spec)))))
3384 ;; This is like line-move-1 except that it also performs
3385 ;; vertical scrolling of tall images if appropriate.
3386 ;; That is not really a clean thing to do, since it mixes
3387 ;; scrolling with cursor motion. But so far we don't have
3388 ;; a cleaner solution to the problem of making C-n do something
3389 ;; useful given a tall image.
3390 (defun line-move (arg &optional noerror to-end try-vscroll)
3391 (if (and auto-window-vscroll try-vscroll
3392 ;; But don't vscroll in a keyboard macro.
3393 (not defining-kbd-macro)
3394 (not executing-kbd-macro))
3395 (let ((forward (> arg 0))
3396 (part (nth 2 (pos-visible-in-window-p (point) nil t))))
3397 (if (and (consp part)
3398 (> (if forward (cdr part) (car part)) 0))
3399 (set-window-vscroll nil
3400 (if forward
3401 (+ (window-vscroll nil t)
3402 (min (cdr part)
3403 (* (frame-char-height) arg)))
3404 (max 0
3405 (- (window-vscroll nil t)
3406 (min (car part)
3407 (* (frame-char-height) (- arg))))))
3408 t)
3409 (set-window-vscroll nil 0)
3410 (when (line-move-1 arg noerror to-end)
3411 (when (not forward)
3412 ;; Update display before calling pos-visible-in-window-p,
3413 ;; because it depends on window-start being up-to-date.
3414 (sit-for 0)
3415 ;; If the current line is partly hidden at the bottom,
3416 ;; scroll it partially up so as to unhide the bottom.
3417 (if (and (setq part (nth 2 (pos-visible-in-window-p
3418 (line-beginning-position) nil t)))
3419 (> (cdr part) 0))
3420 (set-window-vscroll nil (cdr part) t)))
3421 t)))
3422 (line-move-1 arg noerror to-end)))
3424 ;; This is the guts of next-line and previous-line.
3425 ;; Arg says how many lines to move.
3426 ;; The value is t if we can move the specified number of lines.
3427 (defun line-move-1 (arg &optional noerror to-end)
3428 ;; Don't run any point-motion hooks, and disregard intangibility,
3429 ;; for intermediate positions.
3430 (let ((inhibit-point-motion-hooks t)
3431 (opoint (point))
3432 (forward (> arg 0)))
3433 (unwind-protect
3434 (progn
3435 (if (not (memq last-command '(next-line previous-line)))
3436 (setq temporary-goal-column
3437 (if (and track-eol (eolp)
3438 ;; Don't count beg of empty line as end of line
3439 ;; unless we just did explicit end-of-line.
3440 (or (not (bolp)) (eq last-command 'end-of-line)))
3441 9999
3442 (current-column))))
3444 (if (and (not (integerp selective-display))
3445 (not line-move-ignore-invisible))
3446 ;; Use just newline characters.
3447 ;; Set ARG to 0 if we move as many lines as requested.
3448 (or (if (> arg 0)
3449 (progn (if (> arg 1) (forward-line (1- arg)))
3450 ;; This way of moving forward ARG lines
3451 ;; verifies that we have a newline after the last one.
3452 ;; It doesn't get confused by intangible text.
3453 (end-of-line)
3454 (if (zerop (forward-line 1))
3455 (setq arg 0)))
3456 (and (zerop (forward-line arg))
3457 (bolp)
3458 (setq arg 0)))
3459 (unless noerror
3460 (signal (if (< arg 0)
3461 'beginning-of-buffer
3462 'end-of-buffer)
3463 nil)))
3464 ;; Move by arg lines, but ignore invisible ones.
3465 (let (done)
3466 (while (and (> arg 0) (not done))
3467 ;; If the following character is currently invisible,
3468 ;; skip all characters with that same `invisible' property value.
3469 (while (and (not (eobp)) (line-move-invisible-p (point)))
3470 (goto-char (next-char-property-change (point))))
3471 ;; Now move a line.
3472 (end-of-line)
3473 ;; If there's no invisibility here, move over the newline.
3474 (cond
3475 ((eobp)
3476 (if (not noerror)
3477 (signal 'end-of-buffer nil)
3478 (setq done t)))
3479 ((and (> arg 1) ;; Use vertical-motion for last move
3480 (not (integerp selective-display))
3481 (not (line-move-invisible-p (point))))
3482 ;; We avoid vertical-motion when possible
3483 ;; because that has to fontify.
3484 (forward-line 1))
3485 ;; Otherwise move a more sophisticated way.
3486 ((zerop (vertical-motion 1))
3487 (if (not noerror)
3488 (signal 'end-of-buffer nil)
3489 (setq done t))))
3490 (unless done
3491 (setq arg (1- arg))))
3492 ;; The logic of this is the same as the loop above,
3493 ;; it just goes in the other direction.
3494 (while (and (< arg 0) (not done))
3495 (beginning-of-line)
3496 (cond
3497 ((bobp)
3498 (if (not noerror)
3499 (signal 'beginning-of-buffer nil)
3500 (setq done t)))
3501 ((and (< arg -1) ;; Use vertical-motion for last move
3502 (not (integerp selective-display))
3503 (not (line-move-invisible-p (1- (point)))))
3504 (forward-line -1))
3505 ((zerop (vertical-motion -1))
3506 (if (not noerror)
3507 (signal 'beginning-of-buffer nil)
3508 (setq done t))))
3509 (unless done
3510 (setq arg (1+ arg))
3511 (while (and ;; Don't move over previous invis lines
3512 ;; if our target is the middle of this line.
3513 (or (zerop (or goal-column temporary-goal-column))
3514 (< arg 0))
3515 (not (bobp)) (line-move-invisible-p (1- (point))))
3516 (goto-char (previous-char-property-change (point))))))))
3517 ;; This is the value the function returns.
3518 (= arg 0))
3520 (cond ((> arg 0)
3521 ;; If we did not move down as far as desired,
3522 ;; at least go to end of line.
3523 (end-of-line))
3524 ((< arg 0)
3525 ;; If we did not move up as far as desired,
3526 ;; at least go to beginning of line.
3527 (beginning-of-line))
3528 (t
3529 (line-move-finish (or goal-column temporary-goal-column)
3530 opoint forward))))))
3532 (defun line-move-finish (column opoint forward)
3533 (let ((repeat t))
3534 (while repeat
3535 ;; Set REPEAT to t to repeat the whole thing.
3536 (setq repeat nil)
3538 (let (new
3539 (line-beg (save-excursion (beginning-of-line) (point)))
3540 (line-end
3541 ;; Compute the end of the line
3542 ;; ignoring effectively invisible newlines.
3543 (save-excursion
3544 (end-of-line)
3545 (while (and (not (eobp)) (line-move-invisible-p (point)))
3546 (goto-char (next-char-property-change (point)))
3547 (end-of-line))
3548 (point))))
3550 ;; Move to the desired column.
3551 (line-move-to-column column)
3552 (setq new (point))
3554 ;; Process intangibility within a line.
3555 ;; Move to the chosen destination position from above,
3556 ;; with intangibility processing enabled.
3558 (goto-char (point-min))
3559 (let ((inhibit-point-motion-hooks nil))
3560 (goto-char new)
3562 ;; If intangibility moves us to a different (later) place
3563 ;; in the same line, use that as the destination.
3564 (if (<= (point) line-end)
3565 (setq new (point))
3566 ;; If that position is "too late",
3567 ;; try the previous allowable position.
3568 ;; See if it is ok.
3569 (backward-char)
3570 (if (if forward
3571 ;; If going forward, don't accept the previous
3572 ;; allowable position if it is before the target line.
3573 (< line-beg (point))
3574 ;; If going backward, don't accept the previous
3575 ;; allowable position if it is still after the target line.
3576 (<= (point) line-end))
3577 (setq new (point))
3578 ;; As a last resort, use the end of the line.
3579 (setq new line-end))))
3581 ;; Now move to the updated destination, processing fields
3582 ;; as well as intangibility.
3583 (goto-char opoint)
3584 (let ((inhibit-point-motion-hooks nil))
3585 (goto-char
3586 (constrain-to-field new opoint nil t
3587 'inhibit-line-move-field-capture)))
3589 ;; If all this moved us to a different line,
3590 ;; retry everything within that new line.
3591 (when (or (< (point) line-beg) (> (point) line-end))
3592 ;; Repeat the intangibility and field processing.
3593 (setq repeat t))))))
3595 (defun line-move-to-column (col)
3596 "Try to find column COL, considering invisibility.
3597 This function works only in certain cases,
3598 because what we really need is for `move-to-column'
3599 and `current-column' to be able to ignore invisible text."
3600 (if (zerop col)
3601 (beginning-of-line)
3602 (move-to-column col))
3604 (when (and line-move-ignore-invisible
3605 (not (bolp)) (line-move-invisible-p (1- (point))))
3606 (let ((normal-location (point))
3607 (normal-column (current-column)))
3608 ;; If the following character is currently invisible,
3609 ;; skip all characters with that same `invisible' property value.
3610 (while (and (not (eobp))
3611 (line-move-invisible-p (point)))
3612 (goto-char (next-char-property-change (point))))
3613 ;; Have we advanced to a larger column position?
3614 (if (> (current-column) normal-column)
3615 ;; We have made some progress towards the desired column.
3616 ;; See if we can make any further progress.
3617 (line-move-to-column (+ (current-column) (- col normal-column)))
3618 ;; Otherwise, go to the place we originally found
3619 ;; and move back over invisible text.
3620 ;; that will get us to the same place on the screen
3621 ;; but with a more reasonable buffer position.
3622 (goto-char normal-location)
3623 (let ((line-beg (save-excursion (beginning-of-line) (point))))
3624 (while (and (not (bolp)) (line-move-invisible-p (1- (point))))
3625 (goto-char (previous-char-property-change (point) line-beg))))))))
3627 (defun move-end-of-line (arg)
3628 "Move point to end of current line.
3629 With argument ARG not nil or 1, move forward ARG - 1 lines first.
3630 If point reaches the beginning or end of buffer, it stops there.
3631 To ignore intangibility, bind `inhibit-point-motion-hooks' to t.
3633 This command does not move point across a field boundary unless doing so
3634 would move beyond there to a different line; if ARG is nil or 1, and
3635 point starts at a field boundary, point does not move. To ignore field
3636 boundaries bind `inhibit-field-text-motion' to t."
3637 (interactive "p")
3638 (or arg (setq arg 1))
3639 (let (done)
3640 (while (not done)
3641 (let ((newpos
3642 (save-excursion
3643 (let ((goal-column 0))
3644 (and (line-move arg t)
3645 (not (bobp))
3646 (progn
3647 (while (and (not (bobp)) (line-move-invisible-p (1- (point))))
3648 (goto-char (previous-char-property-change (point))))
3649 (backward-char 1)))
3650 (point)))))
3651 (goto-char newpos)
3652 (if (and (> (point) newpos)
3654 (backward-char 1)
3655 (if (and (> (point) newpos) (not (eobp))
3657 ;; If we skipped something intangible
3658 ;; and now we're not really at eol,
3659 ;; keep going.
3660 (setq arg 1)
3661 (setq done t)))))))
3663 (defun move-beginning-of-line (arg)
3664 "Move point to beginning of current display line.
3665 With argument ARG not nil or 1, move forward ARG - 1 lines first.
3666 If point reaches the beginning or end of buffer, it stops there.
3667 To ignore intangibility, bind `inhibit-point-motion-hooks' to t.
3669 This command does not move point across a field boundary unless doing so
3670 would move beyond there to a different line; if ARG is nil or 1, and
3671 point starts at a field boundary, point does not move. To ignore field
3672 boundaries bind `inhibit-field-text-motion' to t."
3673 (interactive "p")
3674 (or arg (setq arg 1))
3675 (if (/= arg 1)
3676 (line-move (1- arg) t))
3677 (beginning-of-line 1)
3678 (let ((orig (point)))
3679 (vertical-motion 0)
3680 (if (/= orig (point))
3681 (goto-char (constrain-to-field (point) orig (/= arg 1) t nil)))))
3684 ;;; Many people have said they rarely use this feature, and often type
3685 ;;; it by accident. Maybe it shouldn't even be on a key.
3686 (put 'set-goal-column 'disabled t)
3688 (defun set-goal-column (arg)
3690 Those commands will move to this position in the line moved to
3691 rather than trying to keep the same horizontal position.
3692 With a non-nil argument, clears out the goal column
3694 The goal column is stored in the variable `goal-column'."
3695 (interactive "P")
3696 (if arg
3697 (progn
3698 (setq goal-column nil)
3699 (message "No goal column"))
3700 (setq goal-column (current-column))
3701 ;; The older method below can be erroneous if `set-goal-column' is bound
3702 ;; to a sequence containing %
3703 ;;(message (substitute-command-keys
3705 ;;goal-column)
3706 (message "%s"
3707 (concat
3708 (format "Goal column %d " goal-column)
3709 (substitute-command-keys
3712 )
3713 nil)
3714 \f
3716 (defun scroll-other-window-down (lines)
3718 For more details, see the documentation for `scroll-other-window'."
3719 (interactive "P")
3720 (scroll-other-window
3721 ;; Just invert the argument's meaning.
3722 ;; We can do that without knowing which window it will be.
3723 (if (eq lines '-) nil
3724 (if (null lines) '-
3725 (- (prefix-numeric-value lines))))))
3727 (defun beginning-of-buffer-other-window (arg)
3728 "Move point to the beginning of the buffer in the other window.
3729 Leave mark at previous position.
3730 With arg N, put point N/10 of the way from the true beginning."
3731 (interactive "P")
3732 (let ((orig-window (selected-window))
3733 (window (other-window-for-scrolling)))
3734 ;; We use unwind-protect rather than save-window-excursion
3735 ;; because the latter would preserve the things we want to change.
3736 (unwind-protect
3737 (progn
3738 (select-window window)
3739 ;; Set point and mark in that window's buffer.
3740 (with-no-warnings
3741 (beginning-of-buffer arg))
3742 ;; Set point accordingly.
3743 (recenter '(t)))
3744 (select-window orig-window))))
3746 (defun end-of-buffer-other-window (arg)
3747 "Move point to the end of the buffer in the other window.
3748 Leave mark at previous position.
3749 With arg N, put point N/10 of the way from the true end."
3750 (interactive "P")
3751 ;; See beginning-of-buffer-other-window for comments.
3752 (let ((orig-window (selected-window))
3753 (window (other-window-for-scrolling)))
3754 (unwind-protect
3755 (progn
3756 (select-window window)
3757 (with-no-warnings
3758 (end-of-buffer arg))
3759 (recenter '(t)))
3760 (select-window orig-window))))
3761 \f
3762 (defun transpose-chars (arg)
3763 "Interchange characters around point, moving forward one character.
3764 With prefix arg ARG, effect is to take character before point
3765 and drag it forward past ARG other characters (backward if ARG negative).
3766 If no argument and at end of line, the previous two chars are exchanged."
3767 (interactive "*P")
3768 (and (null arg) (eolp) (forward-char -1))
3769 (transpose-subr 'forward-char (prefix-numeric-value arg)))
3771 (defun transpose-words (arg)
3772 "Interchange words around point, leaving point at end of them.
3773 With prefix arg ARG, effect is to take word before or around point
3774 and drag it forward past ARG other words (backward if ARG negative).
3775 If ARG is zero, the words around or after point and around or after mark
3776 are interchanged."
3777 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
3778 (interactive "*p")
3779 (transpose-subr 'forward-word arg))
3781 (defun transpose-sexps (arg)
3783 Does not work on a sexp that point is in the middle of
3784 if it is a list or string."
3785 (interactive "*p")
3786 (transpose-subr
3787 (lambda (arg)
3788 ;; Here we should try to simulate the behavior of
3789 ;; (cons (progn (forward-sexp x) (point))
3790 ;; (progn (forward-sexp (- x)) (point)))
3791 ;; Except that we don't want to rely on the second forward-sexp
3792 ;; putting us back to where we want to be, since forward-sexp-function
3793 ;; might do funny things like infix-precedence.
3794 (if (if (> arg 0)
3796 (and (not (bobp))
3798 ;; Jumping over a symbol. We might be inside it, mind you.
3799 (progn (funcall (if (> arg 0)
3800 'skip-syntax-backward 'skip-syntax-forward)
3801 "w_")
3802 (cons (save-excursion (forward-sexp arg) (point)) (point)))
3803 ;; Otherwise, we're between sexps. Take a step back before jumping
3804 ;; to make sure we'll obey the same precedence no matter which direction
3805 ;; we're going.
3806 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
3807 (cons (save-excursion (forward-sexp arg) (point))
3808 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
3809 (not (zerop (funcall (if (> arg 0)
3810 'skip-syntax-forward
3811 'skip-syntax-backward)
3812 ".")))))
3813 (point)))))
3814 arg 'special))
3816 (defun transpose-lines (arg)
3817 "Exchange current line and previous line, leaving point after both.
3818 With argument ARG, takes previous line and moves it past ARG lines.
3819 With argument 0, interchanges line point is in with line mark is in."
3820 (interactive "*p")
3821 (transpose-subr (function
3822 (lambda (arg)
3823 (if (> arg 0)
3824 (progn
3825 ;; Move forward over ARG lines,
3826 ;; but create newlines if necessary.
3827 (setq arg (forward-line arg))
3829 (setq arg (1+ arg)))
3830 (if (> arg 0)
3831 (newline arg)))
3832 (forward-line arg))))
3833 arg))
3835 (defun transpose-subr (mover arg &optional special)
3836 (let ((aux (if special mover
3837 (lambda (x)
3838 (cons (progn (funcall mover x) (point))
3839 (progn (funcall mover (- x)) (point))))))
3840 pos1 pos2)
3841 (cond
3842 ((= arg 0)
3843 (save-excursion
3844 (setq pos1 (funcall aux 1))
3845 (goto-char (mark))
3846 (setq pos2 (funcall aux 1))
3847 (transpose-subr-1 pos1 pos2))
3848 (exchange-point-and-mark))
3849 ((> arg 0)
3850 (setq pos1 (funcall aux -1))
3851 (setq pos2 (funcall aux arg))
3852 (transpose-subr-1 pos1 pos2)
3853 (goto-char (car pos2)))
3854 (t
3855 (setq pos1 (funcall aux -1))
3856 (goto-char (car pos1))
3857 (setq pos2 (funcall aux arg))
3858 (transpose-subr-1 pos1 pos2)))))
3860 (defun transpose-subr-1 (pos1 pos2)
3861 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
3862 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
3863 (when (> (car pos1) (car pos2))
3864 (let ((swap pos1))
3865 (setq pos1 pos2 pos2 swap)))
3866 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
3867 (atomic-change-group
3868 (let (word2)
3869 ;; FIXME: We first delete the two pieces of text, so markers that
3870 ;; used to point to after the text end up pointing to before it :-(
3871 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
3872 (goto-char (car pos2))
3873 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
3874 (goto-char (car pos1))
3875 (insert word2))))
3876 \f
3877 (defun backward-word (&optional arg)
3878 "Move backward until encountering the beginning of a word.
3879 With argument, do this that many times."
3880 (interactive "p")
3881 (forward-word (- (or arg 1))))
3883 (defun mark-word (&optional arg allow-extend)
3884 "Set mark ARG words away from point.
3886 move to with the same argument.
3887 Interactively, if this command is repeated
3888 or (in Transient Mark mode) if the mark is active,
3889 it marks the next ARG words after the ones already marked."
3891 (cond ((and allow-extend
3892 (or (and (eq last-command this-command) (mark t))
3893 (and transient-mark-mode mark-active)))
3894 (setq arg (if arg (prefix-numeric-value arg)
3895 (if (< (mark) (point)) -1 1)))
3896 (set-mark
3897 (save-excursion
3898 (goto-char (mark))
3899 (forward-word arg)
3900 (point))))
3901 (t
3902 (push-mark
3903 (save-excursion
3904 (forward-word (prefix-numeric-value arg))
3905 (point))
3906 nil t))))
3908 (defun kill-word (arg)
3909 "Kill characters forward until encountering the end of a word.
3910 With argument, do this that many times."
3911 (interactive "p")
3912 (kill-region (point) (progn (forward-word arg) (point))))
3914 (defun backward-kill-word (arg)
3915 "Kill characters backward until encountering the end of a word.
3916 With argument, do this that many times."
3917 (interactive "p")
3918 (kill-word (- arg)))
3920 (defun current-word (&optional strict really-word)
3921 "Return the symbol or word that point is on (or a nearby one) as a string.
3922 The return value includes no text properties.
3923 If optional arg STRICT is non-nil, return nil unless point is within
3924 or adjacent to a symbol or word. In all cases the value can be nil
3925 if there is no word nearby.
3926 The function, belying its name, normally finds a symbol.
3927 If optional arg REALLY-WORD is non-nil, it finds just a word."
3928 (save-excursion
3929 (let* ((oldpoint (point)) (start (point)) (end (point))
3930 (syntaxes (if really-word "w" "w_"))
3931 (not-syntaxes (concat "^" syntaxes)))
3932 (skip-syntax-backward syntaxes) (setq start (point))
3933 (goto-char oldpoint)
3934 (skip-syntax-forward syntaxes) (setq end (point))
3935 (when (and (eq start oldpoint) (eq end oldpoint)
3936 ;; Point is neither within nor adjacent to a word.
3937 (not strict))
3938 ;; Look for preceding word in same line.
3939 (skip-syntax-backward not-syntaxes
3940 (save-excursion (beginning-of-line)
3941 (point)))
3942 (if (bolp)
3943 ;; No preceding word in same line.
3944 ;; Look for following word in same line.
3945 (progn
3946 (skip-syntax-forward not-syntaxes
3947 (save-excursion (end-of-line)
3948 (point)))
3949 (setq start (point))
3950 (skip-syntax-forward syntaxes)
3951 (setq end (point)))
3952 (setq end (point))
3953 (skip-syntax-backward syntaxes)
3954 (setq start (point))))
3955 ;; If we found something nonempty, return it as a string.
3956 (unless (= start end)
3957 (buffer-substring-no-properties start end)))))
3958 \f
3959 (defcustom fill-prefix nil
3960 "*String for filling to insert at front of new line, or nil for none."
3961 :type '(choice (const :tag "None" nil)
3962 string)
3963 :group 'fill)
3964 (make-variable-buffer-local 'fill-prefix)
3966 (defcustom auto-fill-inhibit-regexp nil
3967 "*Regexp to match lines which should not be auto-filled."
3968 :type '(choice (const :tag "None" nil)
3969 regexp)
3970 :group 'fill)
3972 (defvar comment-line-break-function 'comment-indent-new-line
3973 "*Mode-specific function which line breaks and continues a comment.
3975 This function is only called during auto-filling of a comment section.
3976 The function should take a single optional argument, which is a flag
3977 indicating whether it should use soft newlines.")
3979 ;; This function is used as the auto-fill-function of a buffer
3980 ;; when Auto-Fill mode is enabled.
3981 ;; It returns t if it really did any work.
3982 ;; (Actually some major modes use a different auto-fill function,
3983 ;; but this one is the default one.)
3984 (defun do-auto-fill ()
3985 (let (fc justify give-up
3986 (fill-prefix fill-prefix))
3987 (if (or (not (setq justify (current-justification)))
3988 (null (setq fc (current-fill-column)))
3989 (and (eq justify 'left)
3990 (<= (current-column) fc))
3991 (and auto-fill-inhibit-regexp
3992 (save-excursion (beginning-of-line)
3993 (looking-at auto-fill-inhibit-regexp))))
3994 nil ;; Auto-filling not required
3995 (if (memq justify '(full center right))
3996 (save-excursion (unjustify-current-line)))
3998 ;; Choose a fill-prefix automatically.
3999 (when (and adaptive-fill-mode
4000 (or (null fill-prefix) (string= fill-prefix "")))
4001 (let ((prefix
4002 (fill-context-prefix
4003 (save-excursion (backward-paragraph 1) (point))
4004 (save-excursion (forward-paragraph 1) (point)))))
4005 (and prefix (not (equal prefix ""))
4006 ;; Use auto-indentation rather than a guessed empty prefix.
4007 (not (and fill-indent-according-to-mode
4009 (setq fill-prefix prefix))))
4011 (while (and (not give-up) (> (current-column) fc))
4012 ;; Determine where to split the line.
4013 (let* (after-prefix
4014 (fill-point
4015 (save-excursion
4016 (beginning-of-line)
4017 (setq after-prefix (point))
4018 (and fill-prefix
4019 (looking-at (regexp-quote fill-prefix))
4020 (setq after-prefix (match-end 0)))
4021 (move-to-column (1+ fc))
4022 (fill-move-to-break-point after-prefix)
4023 (point))))
4025 ;; See whether the place we found is any good.
4026 (if (save-excursion
4027 (goto-char fill-point)
4028 (or (bolp)
4029 ;; There is no use breaking at end of line.
4030 (save-excursion (skip-chars-forward " ") (eolp))
4031 ;; It is futile to split at the end of the prefix
4032 ;; since we would just insert the prefix again.
4033 (and after-prefix (<= (point) after-prefix))
4034 ;; Don't split right after a comment starter
4035 ;; since we would just make another comment starter.
4036 (and comment-start-skip
4037 (let ((limit (point)))
4038 (beginning-of-line)
4039 (and (re-search-forward comment-start-skip
4040 limit t)
4041 (eq (point) limit))))))
4042 ;; No good place to break => stop trying.
4043 (setq give-up t)
4044 ;; Ok, we have a useful place to break the line. Do it.
4045 (let ((prev-column (current-column)))
4046 ;; If point is at the fill-point, do not `save-excursion'.
4047 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
4048 ;; point will end up before it rather than after it.
4049 (if (save-excursion
4051 (= (point) fill-point))
4052 (funcall comment-line-break-function t)
4053 (save-excursion
4054 (goto-char fill-point)
4055 (funcall comment-line-break-function t)))
4056 ;; Now do justification, if required
4057 (if (not (eq justify 'left))
4058 (save-excursion
4059 (end-of-line 0)
4060 (justify-current-line justify nil t)))
4061 ;; If making the new line didn't reduce the hpos of
4062 ;; the end of the line, then give up now;
4063 ;; trying again will not help.
4064 (if (>= (current-column) prev-column)
4065 (setq give-up t))))))
4066 ;; Justify last line.
4067 (justify-current-line justify t t)
4068 t)))
4070 (defvar normal-auto-fill-function 'do-auto-fill
4071 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
4072 Some major modes set this.")
4074 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
4075 ;; FIXME: turn into a proper minor mode.
4076 ;; Add a global minor mode version of it.
4077 (defun auto-fill-mode (&optional arg)
4078 "Toggle Auto Fill mode.
4079 With arg, turn Auto Fill mode on if and only if arg is positive.
4080 In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
4081 automatically breaks the line at a previous space.
4083 The value of `normal-auto-fill-function' specifies the function to use
4084 for `auto-fill-function' when turning Auto Fill mode on."
4085 (interactive "P")
4086 (prog1 (setq auto-fill-function
4087 (if (if (null arg)
4088 (not auto-fill-function)
4089 (> (prefix-numeric-value arg) 0))
4090 normal-auto-fill-function
4091 nil))
4092 (force-mode-line-update)))
4094 ;; This holds a document string used to document auto-fill-mode.
4095 (defun auto-fill-function ()
4096 "Automatically break line at a previous space, in insertion of text."
4097 nil)
4099 (defun turn-on-auto-fill ()
4100 "Unconditionally turn on Auto Fill mode."
4101 (auto-fill-mode 1))
4103 (defun turn-off-auto-fill ()
4104 "Unconditionally turn off Auto Fill mode."
4105 (auto-fill-mode -1))
4107 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
4109 (defun set-fill-column (arg)
4110 "Set `fill-column' to specified argument.
4113 (interactive "P")
4114 (if (consp arg)
4115 (setq arg (current-column)))
4116 (if (not (integerp arg))
4117 ;; Disallow missing argument; it's probably a typo for C-x C-f.
4118 (error "set-fill-column requires an explicit argument")
4119 (message "Fill column set to %d (was %d)" arg fill-column)
4120 (setq fill-column arg)))
4121 \f
4122 (defun set-selective-display (arg)
4123 "Set `selective-display' to ARG; clear it if no arg.
4124 When the value of `selective-display' is a number > 0,
4125 lines whose indentation is >= that value are not displayed.
4126 The variable `selective-display' has a separate value for each buffer."
4127 (interactive "P")
4128 (if (eq selective-display t)
4129 (error "selective-display already in use for marked lines"))
4130 (let ((current-vpos
4131 (save-restriction
4132 (narrow-to-region (point-min) (point))
4133 (goto-char (window-start))
4134 (vertical-motion (window-height)))))
4135 (setq selective-display
4136 (and arg (prefix-numeric-value arg)))
4137 (recenter current-vpos))
4138 (set-window-start (selected-window) (window-start (selected-window)))
4139 (princ "selective-display set to " t)
4140 (prin1 selective-display t)
4141 (princ "." t))
4143 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
4144 (defvaralias 'default-indicate-unused-lines 'default-indicate-empty-lines)
4146 (defun toggle-truncate-lines (arg)
4147 "Toggle whether to fold or truncate long lines on the screen.
4148 With arg, truncate long lines iff arg is positive.
4149 Note that in side-by-side windows, truncation is always enabled."
4150 (interactive "P")
4151 (setq truncate-lines
4152 (if (null arg)
4153 (not truncate-lines)
4154 (> (prefix-numeric-value arg) 0)))
4155 (force-mode-line-update)
4156 (unless truncate-lines
4157 (let ((buffer (current-buffer)))
4158 (walk-windows (lambda (window)
4159 (if (eq buffer (window-buffer window))
4160 (set-window-hscroll window 0)))
4161 nil t)))
4162 (message "Truncate long lines %s"
4163 (if truncate-lines "enabled" "disabled")))
4165 (defvar overwrite-mode-textual " Ovwrt"
4166 "The string displayed in the mode line when in overwrite mode.")
4167 (defvar overwrite-mode-binary " Bin Ovwrt"
4168 "The string displayed in the mode line when in binary overwrite mode.")
4170 (defun overwrite-mode (arg)
4171 "Toggle overwrite mode.
4172 With arg, turn overwrite mode on iff arg is positive.
4173 In overwrite mode, printing characters typed in replace existing text
4174 on a one-for-one basis, rather than pushing it to the right. At the
4175 end of a line, such characters extend the line. Before a tab,
4176 such characters insert until the tab is filled in.
4178 is supposed to make it easier to insert characters when necessary."
4179 (interactive "P")
4180 (setq overwrite-mode
4181 (if (if (null arg) (not overwrite-mode)
4182 (> (prefix-numeric-value arg) 0))
4183 'overwrite-mode-textual))
4184 (force-mode-line-update))
4186 (defun binary-overwrite-mode (arg)
4187 "Toggle binary overwrite mode.
4188 With arg, turn binary overwrite mode on iff arg is positive.
4189 In binary overwrite mode, printing characters typed in replace
4190 existing text. Newlines are not treated specially, so typing at the
4191 end of a line joins the line to the next, with the typed character
4192 between them. Typing before a tab character simply replaces the tab
4193 with the character typed.
4195 typing characters do.
4197 Note that binary overwrite mode is not its own minor mode; it is a
4198 specialization of overwrite mode, entered by setting the
4199 `overwrite-mode' variable to `overwrite-mode-binary'."
4200 (interactive "P")
4201 (setq overwrite-mode
4202 (if (if (null arg)
4203 (not (eq overwrite-mode 'overwrite-mode-binary))
4204 (> (prefix-numeric-value arg) 0))
4205 'overwrite-mode-binary))
4206 (force-mode-line-update))
4208 (define-minor-mode line-number-mode
4209 "Toggle Line Number mode.
4210 With arg, turn Line Number mode on iff arg is positive.
4211 When Line Number mode is enabled, the line number appears
4212 in the mode line.
4214 Line numbers do not appear for very large buffers and buffers
4215 with very long lines; see variables `line-number-display-limit'
4216 and `line-number-display-limit-width'."
4217 :init-value t :global t :group 'editing-basics :require nil)
4219 (define-minor-mode column-number-mode
4220 "Toggle Column Number mode.
4221 With arg, turn Column Number mode on iff arg is positive.
4222 When Column Number mode is enabled, the column number appears
4223 in the mode line."
4224 :global t :group 'editing-basics :require nil)
4226 (define-minor-mode size-indication-mode
4227 "Toggle Size Indication mode.
4228 With arg, turn Size Indication mode on iff arg is positive. When
4229 Size Indication mode is enabled, the size of the accessible part
4230 of the buffer appears in the mode line."
4231 :global t :group 'editing-basics :require nil)
4232 \f
4233 (defgroup paren-blinking nil
4234 "Blinking matching of parens and expressions."
4235 :prefix "blink-matching-"
4236 :group 'paren-matching)
4238 (defcustom blink-matching-paren t
4239 "*Non-nil means show matching open-paren when close-paren is inserted."
4240 :type 'boolean
4241 :group 'paren-blinking)
4243 (defcustom blink-matching-paren-on-screen t
4244 "*Non-nil means show matching open-paren when it is on screen.
4245 If nil, means don't show it (but the open-paren can still be shown
4246 when it is off screen)."
4247 :type 'boolean
4248 :group 'paren-blinking)
4250 (defcustom blink-matching-paren-distance (* 25 1024)
4251 "*If non-nil, maximum distance to search backwards for matching open-paren.
4252 If nil, search stops at the beginning of the accessible portion of the buffer."
4253 :type '(choice (const nil) integer)
4254 :group 'paren-blinking)
4256 (defcustom blink-matching-delay 1
4257 "*Time in seconds to delay after showing a matching paren."
4258 :type 'number
4259 :group 'paren-blinking)
4261 (defcustom blink-matching-paren-dont-ignore-comments nil
4262 "*Non-nil means `blink-matching-paren' will not ignore comments."
4263 :type 'boolean
4264 :group 'paren-blinking)
4266 (defun blink-matching-open ()
4267 "Move cursor momentarily to the beginning of the sexp before point."
4268 (interactive)
4269 (when (and (> (point) (point-min))
4270 blink-matching-paren
4271 ;; Verify an even number of quoting characters precede the close.
4272 (= 1 (logand 1 (- (point)
4273 (save-excursion
4274 (forward-char -1)
4276 (point))))))
4277 (let* ((oldpos (point))
4278 blinkpos
4279 message-log-max ; Don't log messages about paren matching.
4280 matching-paren
4281 open-paren-line-string)
4282 (save-excursion
4283 (save-restriction
4284 (if blink-matching-paren-distance
4285 (narrow-to-region (max (point-min)
4286 (- (point) blink-matching-paren-distance))
4287 oldpos))
4288 (condition-case ()
4289 (let ((parse-sexp-ignore-comments
4290 (and parse-sexp-ignore-comments
4291 (not blink-matching-paren-dont-ignore-comments))))
4292 (setq blinkpos (scan-sexps oldpos -1)))
4293 (error nil)))
4294 (and blinkpos
4295 ;; Not syntax '$'.
4296 (not (eq (syntax-class (syntax-after blinkpos)) 8))
4297 (setq matching-paren
4298 (let ((syntax (syntax-after blinkpos)))
4299 (and (consp syntax)
4300 (eq (syntax-class syntax) 4)
4301 (cdr syntax)))))
4302 (cond
4303 ((or (null matching-paren)
4304 (/= (char-before oldpos)
4305 matching-paren))
4306 (message "Mismatched parentheses"))
4307 ((not blinkpos)
4308 (if (not blink-matching-paren-distance)
4309 (message "Unmatched parenthesis")))
4310 ((pos-visible-in-window-p blinkpos)
4311 ;; Matching open within window, temporarily move to blinkpos but only
4312 ;; if `blink-matching-paren-on-screen' is non-nil.
4313 (when blink-matching-paren-on-screen
4314 (save-excursion
4315 (goto-char blinkpos)
4316 (sit-for blink-matching-delay))))
4317 (t
4318 (save-excursion
4319 (goto-char blinkpos)
4320 (setq open-paren-line-string
4321 ;; Show what precedes the open in its line, if anything.
4322 (if (save-excursion
4324 (not (bolp)))
4325 (buffer-substring (line-beginning-position)
4326 (1+ blinkpos))
4327 ;; Show what follows the open in its line, if anything.
4328 (if (save-excursion
4329 (forward-char 1)
4331 (not (eolp)))
4332 (buffer-substring blinkpos
4333 (line-end-position))
4334 ;; Otherwise show the previous nonblank line,
4335 ;; if there is one.
4336 (if (save-excursion
4338 (not (bobp)))
4339 (concat
4340 (buffer-substring (progn
4342 (line-beginning-position))
4343 (progn (end-of-line)
4345 (point)))
4346 ;; Replace the newline and other whitespace with `...'.
4347 "..."
4348 (buffer-substring blinkpos (1+ blinkpos)))
4349 ;; There is nothing to show except the char itself.
4350 (buffer-substring blinkpos (1+ blinkpos)))))))
4351 (message "Matches %s"
4352 (substring-no-properties open-paren-line-string))))))))
4354 ;Turned off because it makes dbx bomb out.
4355 (setq blink-paren-function 'blink-matching-open)
4356 \f
4357 ;; This executes C-g typed while Emacs is waiting for a command.
4358 ;; Quitting out of a program does not go through here;
4359 ;; that happens in the QUIT macro at the C code level.
4360 (defun keyboard-quit ()
4361 "Signal a `quit' condition.
4362 During execution of Lisp code, this character causes a quit directly.
4363 At top-level, as an editor command, this simply beeps."
4364 (interactive)
4365 (deactivate-mark)
4366 (if (fboundp 'kmacro-keyboard-quit)
4367 (kmacro-keyboard-quit))
4368 (setq defining-kbd-macro nil)
4369 (signal 'quit nil))
4371 (defvar buffer-quit-function nil
4374 \(such as cancelling a prefix argument, minibuffer or region) do not apply.")
4376 (defun keyboard-escape-quit ()
4378 This command can exit an interactive command such as `query-replace',
4379 can clear out a prefix argument or a region,
4380 can get out of the minibuffer or other recursive edit,
4381 cancel the use of the current buffer (for special-purpose buffers),
4382 or go back to just one window (by deleting all but the selected window)."
4383 (interactive)
4384 (cond ((eq last-command 'mode-exited) nil)
4385 ((> (minibuffer-depth) 0)
4386 (abort-recursive-edit))
4387 (current-prefix-arg
4388 nil)
4389 ((and transient-mark-mode mark-active)
4390 (deactivate-mark))
4391 ((> (recursion-depth) 0)
4392 (exit-recursive-edit))
4393 (buffer-quit-function
4394 (funcall buffer-quit-function))
4395 ((not (one-window-p t))
4396 (delete-other-windows))
4398 (bury-buffer))))
4400 (defun play-sound-file (file &optional volume device)
4401 "Play sound stored in FILE.
4402 VOLUME and DEVICE correspond to the keywords of the sound
4403 specification for `play-sound'."
4404 (interactive "fPlay sound file: ")
4405 (let ((sound (list :file file)))
4406 (if volume
4407 (plist-put sound :volume volume))
4408 (if device
4409 (plist-put sound :device device))
4410 (push 'sound sound)
4411 (play-sound sound)))
4413 \f
4414 (defcustom read-mail-command 'rmail
4415 "*Your preference for a mail reading package.
4416 This is used by some keybindings which support reading mail.
4417 See also `mail-user-agent' concerning sending mail."
4418 :type '(choice (function-item rmail)
4419 (function-item gnus)
4420 (function-item mh-rmail)
4421 (function :tag "Other"))
4422 :version "21.1"
4423 :group 'mail)
4425 (defcustom mail-user-agent 'sendmail-user-agent
4426 "*Your preference for a mail composition package.
4427 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
4428 outgoing email message. This variable lets you specify which
4429 mail-sending package you prefer.
4431 Valid values include:
4433 `sendmail-user-agent' -- use the default Emacs Mail package.
4434 See Info node `(emacs)Sending Mail'.
4435 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
4436 See Info node `(mh-e)'.
4437 `message-user-agent' -- use the Gnus Message package.
4438 See Info node `(message)'.
4439 `gnus-user-agent' -- like `message-user-agent', but with Gnus
4440 paraphernalia, particularly the Gcc: header for
4441 archiving.
4443 Additional valid symbols may be available; check with the author of
4444 your package for details. The function should return non-nil if it
4445 succeeds.
4447 See also `read-mail-command' concerning reading mail."
4448 :type '(radio (function-item :tag "Default Emacs mail"
4450 sendmail-user-agent)
4451 (function-item :tag "Emacs interface to MH"
4453 mh-e-user-agent)
4454 (function-item :tag "Gnus Message package"
4456 message-user-agent)
4457 (function-item :tag "Gnus Message with full Gnus features"
4459 gnus-user-agent)
4460 (function :tag "Other"))
4461 :group 'mail)
4463 (define-mail-user-agent 'sendmail-user-agent
4464 'sendmail-user-agent-compose
4465 'mail-send-and-exit)
4467 (defun rfc822-goto-eoh ()
4468 ;; Go to header delimiter line in a mail message, following RFC822 rules
4469 (goto-char (point-min))
4470 (when (re-search-forward
4472 (goto-char (match-beginning 0))))
4474 (defun sendmail-user-agent-compose (&optional to subject other-headers continue
4475 switch-function yank-action
4476 send-actions)
4477 (if switch-function
4478 (let ((special-display-buffer-names nil)
4479 (special-display-regexps nil)
4480 (same-window-buffer-names nil)
4481 (same-window-regexps nil))
4482 (funcall switch-function "*mail*")))
4483 (let ((cc (cdr (assoc-string "cc" other-headers t)))
4484 (in-reply-to (cdr (assoc-string "in-reply-to" other-headers t)))
4485 (body (cdr (assoc-string "body" other-headers t))))
4486 (or (mail continue to subject in-reply-to cc yank-action send-actions)
4487 continue
4488 (error "Message aborted"))
4489 (save-excursion
4490 (rfc822-goto-eoh)
4491 (while other-headers
4492 (unless (member-ignore-case (car (car other-headers))
4493 '("in-reply-to" "cc" "body"))
4494 (insert (car (car other-headers)) ": "
4496 (setq other-headers (cdr other-headers)))
4497 (when body
4498 (forward-line 1)
4499 (insert body))
4500 t)))
4502 (define-mail-user-agent 'mh-e-user-agent
4503 'mh-smail-batch 'mh-send-letter 'mh-fully-kill-draft
4504 'mh-before-send-letter-hook)
4506 (defun compose-mail (&optional to subject other-headers continue
4507 switch-function yank-action send-actions)
4508 "Start composing a mail message to send.
4509 This uses the user's chosen mail composition package
4510 as selected with the variable `mail-user-agent'.
4511 The optional arguments TO and SUBJECT specify recipients
4512 and the initial Subject field, respectively.
4514 OTHER-HEADERS is an alist specifying additional
4515 header fields. Elements look like (HEADER . VALUE) where both
4516 HEADER and VALUE are strings.
4518 CONTINUE, if non-nil, says to continue editing a message already
4519 being composed.
4521 SWITCH-FUNCTION, if non-nil, is a function to use to
4522 switch to and display the buffer used for mail composition.
4524 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
4525 to insert the raw text of the message being replied to.
4526 It has the form (FUNCTION . ARGS). The user agent will apply
4527 FUNCTION to ARGS, to insert the raw text of the original message.
4528 \(The user agent will also run `mail-citation-hook', *after* the
4529 original text has been inserted in this way.)
4531 SEND-ACTIONS is a list of actions to call when the message is sent.
4532 Each action has the form (FUNCTION . ARGS)."
4533 (interactive
4534 (list nil nil nil current-prefix-arg))
4535 (let ((function (get mail-user-agent 'composefunc)))
4536 (funcall function to subject other-headers continue
4537 switch-function yank-action send-actions)))
4539 (defun compose-mail-other-window (&optional to subject other-headers continue
4540 yank-action send-actions)
4542 (interactive
4543 (list nil nil nil current-prefix-arg))
4544 (compose-mail to subject other-headers continue
4545 'switch-to-buffer-other-window yank-action send-actions))
4548 (defun compose-mail-other-frame (&optional to subject other-headers continue
4549 yank-action send-actions)
4551 (interactive
4552 (list nil nil nil current-prefix-arg))
4553 (compose-mail to subject other-headers continue
4554 'switch-to-buffer-other-frame yank-action send-actions))
4555 \f
4556 (defvar set-variable-value-history nil
4557 "History of values entered with `set-variable'.")
4559 (defun set-variable (variable value &optional make-local)
4560 "Set VARIABLE to VALUE. VALUE is a Lisp object.
4561 VARIABLE should be a user option variable name, a Lisp variable
4562 meant to be customized by users. You should enter VALUE in Lisp syntax,
4563 so if you want VALUE to be a string, you must surround it with doublequotes.
4564 VALUE is used literally, not evaluated.
4566 If VARIABLE has a `variable-interactive' property, that is used as if
4567 it were the arg to `interactive' (which see) to interactively read VALUE.
4569 If VARIABLE has been defined with `defcustom', then the type information
4570 in the definition is used to check that VALUE is valid.
4572 With a prefix argument, set VARIABLE to VALUE buffer-locally."
4573 (interactive
4574 (let* ((default-var (variable-at-point))
4575 (var (if (user-variable-p default-var)
4576 (read-variable (format "Set variable (default %s): " default-var)
4577 default-var)
4578 (read-variable "Set variable: ")))
4579 (minibuffer-help-form '(describe-variable var))
4580 (prop (get var 'variable-interactive))
4581 (obsolete (car (get var 'byte-obsolete-variable)))
4582 (prompt (format "Set %s %s to value: " var
4583 (cond ((local-variable-p var)
4584 "(buffer-local)")
4585 ((or current-prefix-arg
4586 (local-variable-if-set-p var))
4587 "buffer-locally")
4588 (t "globally"))))
4589 (val (progn
4590 (when obsolete
4591 (message (concat "`%S' is obsolete; "
4592 (if (symbolp obsolete) "use `%S' instead" "%s"))
4593 var obsolete)
4594 (sit-for 3))
4595 (if prop
4596 ;; Use VAR's `variable-interactive' property
4597 ;; as an interactive spec for prompting.
4598 (call-interactively `(lambda (arg)
4599 (interactive ,prop)
4600 arg))
4601 (read
4602 (read-string prompt nil
4603 'set-variable-value-history
4604 (format "%S" (symbol-value var))))))))
4605 (list var val current-prefix-arg)))
4607 (and (custom-variable-p variable)
4608 (not (get variable 'custom-type))
4609 (custom-load-symbol variable))
4610 (let ((type (get variable 'custom-type)))
4611 (when type
4612 ;; Match with custom type.
4613 (require 'cus-edit)
4614 (setq type (widget-convert type))
4615 (unless (widget-apply type :match value)
4616 (error "Value `%S' does not match type %S of %S"
4617 value (car type) variable))))
4619 (if make-local
4620 (make-local-variable variable))
4622 (set variable value)
4624 ;; Force a thorough redisplay for the case that the variable
4625 ;; has an effect on the display, like `tab-width' has.
4626 (force-mode-line-update))
4627 \f
4628 ;; Define the major mode for lists of completions.
4630 (defvar completion-list-mode-map nil
4631 "Local map for completion list buffers.")
4632 (or completion-list-mode-map
4633 (let ((map (make-sparse-keymap)))
4634 (define-key map [mouse-2] 'mouse-choose-completion)
4635 (define-key map [follow-link] 'mouse-face)
4636 (define-key map [down-mouse-2] nil)
4637 (define-key map "\C-m" 'choose-completion)
4638 (define-key map "\e\e\e" 'delete-completion-window)
4639 (define-key map [left] 'previous-completion)
4640 (define-key map [right] 'next-completion)
4641 (setq completion-list-mode-map map)))
4643 ;; Completion mode is suitable only for specially formatted data.
4644 (put 'completion-list-mode 'mode-class 'special)
4646 (defvar completion-reference-buffer nil
4647 "Record the buffer that was current when the completion list was requested.
4648 This is a local variable in the completion list buffer.
4649 Initial value is nil to avoid some compiler warnings.")
4651 (defvar completion-no-auto-exit nil
4652 "Non-nil means `choose-completion-string' should never exit the minibuffer.
4653 This also applies to other functions such as `choose-completion'
4654 and `mouse-choose-completion'.")
4656 (defvar completion-base-size nil
4657 "Number of chars at beginning of minibuffer not involved in completion.
4658 This is a local variable in the completion list buffer
4659 but it talks about the buffer in `completion-reference-buffer'.
4660 If this is nil, it means to compare text to determine which part
4661 of the tail end of the buffer's text is involved in completion.")
4663 (defun delete-completion-window ()
4664 "Delete the completion list window.
4665 Go to the window from which completion was requested."
4666 (interactive)
4667 (let ((buf completion-reference-buffer))
4668 (if (one-window-p t)
4669 (if (window-dedicated-p (selected-window))
4670 (delete-frame (selected-frame)))
4671 (delete-window (selected-window))
4672 (if (get-buffer-window buf)
4673 (select-window (get-buffer-window buf))))))
4675 (defun previous-completion (n)
4676 "Move to the previous item in the completion list."
4677 (interactive "p")
4678 (next-completion (- n)))
4680 (defun next-completion (n)
4681 "Move to the next item in the completion list.
4682 With prefix argument N, move N items (negative N means move backward)."
4683 (interactive "p")
4684 (let ((beg (point-min)) (end (point-max)))
4685 (while (and (> n 0) (not (eobp)))
4686 ;; If in a completion, move to the end of it.
4687 (when (get-text-property (point) 'mouse-face)
4688 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
4689 ;; Move to start of next one.
4690 (unless (get-text-property (point) 'mouse-face)
4691 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
4692 (setq n (1- n)))
4693 (while (and (< n 0) (not (bobp)))
4694 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
4695 ;; If in a completion, move to the start of it.
4696 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
4697 (goto-char (previous-single-property-change
4698 (point) 'mouse-face nil beg)))
4699 ;; Move to end of the previous completion.
4700 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
4701 (goto-char (previous-single-property-change
4702 (point) 'mouse-face nil beg)))
4703 ;; Move to the start of that one.
4704 (goto-char (previous-single-property-change
4705 (point) 'mouse-face nil beg))
4706 (setq n (1+ n))))))
4708 (defun choose-completion ()
4709 "Choose the completion that point is in or next to."
4710 (interactive)
4711 (let (beg end completion (buffer completion-reference-buffer)
4712 (base-size completion-base-size))
4713 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
4714 (setq end (point) beg (1+ (point))))
4715 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
4716 (setq end (1- (point)) beg (point)))
4717 (if (null beg)
4718 (error "No completion here"))
4719 (setq beg (previous-single-property-change beg 'mouse-face))
4720 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
4721 (setq completion (buffer-substring beg end))
4722 (let ((owindow (selected-window)))
4723 (if (and (one-window-p t 'selected-frame)
4724 (window-dedicated-p (selected-window)))
4725 ;; This is a special buffer's frame
4726 (iconify-frame (selected-frame))
4727 (or (window-dedicated-p (selected-window))
4728 (bury-buffer)))
4729 (select-window owindow))
4730 (choose-completion-string completion buffer base-size)))
4732 ;; Delete the longest partial match for STRING
4733 ;; that can be found before POINT.
4734 (defun choose-completion-delete-max-match (string)
4735 (let ((opoint (point))
4736 len)
4737 ;; Try moving back by the length of the string.
4738 (goto-char (max (- (point) (length string))
4739 (minibuffer-prompt-end)))
4740 ;; See how far back we were actually able to move. That is the
4741 ;; upper bound on how much we can match and delete.
4742 (setq len (- opoint (point)))
4743 (if completion-ignore-case
4744 (setq string (downcase string)))
4745 (while (and (> len 0)
4746 (let ((tail (buffer-substring (point) opoint)))
4747 (if completion-ignore-case
4748 (setq tail (downcase tail)))
4749 (not (string= tail (substring string 0 len)))))
4750 (setq len (1- len))
4751 (forward-char 1))
4752 (delete-char len)))
4754 (defvar choose-completion-string-functions nil
4755 "Functions that may override the normal insertion of a completion choice.
4756 These functions are called in order with four arguments:
4757 CHOICE - the string to insert in the buffer,
4758 BUFFER - the buffer in which the choice should be inserted,
4759 MINI-P - non-nil iff BUFFER is a minibuffer, and
4760 BASE-SIZE - the number of characters in BUFFER before
4761 the string being completed.
4763 If a function in the list returns non-nil, that function is supposed
4764 to have inserted the CHOICE in the BUFFER, and possibly exited
4765 the minibuffer; no further functions will be called.
4767 If all functions in the list return nil, that means to use
4768 the default method of inserting the completion in BUFFER.")
4770 (defun choose-completion-string (choice &optional buffer base-size)
4771 "Switch to BUFFER and insert the completion choice CHOICE.
4772 BASE-SIZE, if non-nil, says how many characters of BUFFER's text
4773 to keep. If it is nil, we call `choose-completion-delete-max-match'
4774 to decide what to delete."
4776 ;; If BUFFER is the minibuffer, exit the minibuffer
4777 ;; unless it is reading a file name and CHOICE is a directory,
4778 ;; or completion-no-auto-exit is non-nil.
4780 (let* ((buffer (or buffer completion-reference-buffer))
4781 (mini-p (minibufferp buffer)))
4782 ;; If BUFFER is a minibuffer, barf unless it's the currently
4783 ;; active minibuffer.
4784 (if (and mini-p
4785 (or (not (active-minibuffer-window))
4786 (not (equal buffer
4787 (window-buffer (active-minibuffer-window))))))
4788 (error "Minibuffer is not active for completion")
4789 ;; Set buffer so buffer-local choose-completion-string-functions works.
4790 (set-buffer buffer)
4791 (unless (run-hook-with-args-until-success
4792 'choose-completion-string-functions
4793 choice buffer mini-p base-size)
4794 ;; Insert the completion into the buffer where it was requested.
4795 (if base-size
4796 (delete-region (+ base-size (if mini-p
4797 (minibuffer-prompt-end)
4798 (point-min)))
4799 (point))
4800 (choose-completion-delete-max-match choice))
4801 (insert choice)
4802 (remove-text-properties (- (point) (length choice)) (point)
4803 '(mouse-face nil))
4804 ;; Update point in the window that BUFFER is showing in.
4805 (let ((window (get-buffer-window buffer t)))
4806 (set-window-point window (point)))
4807 ;; If completing for the minibuffer, exit it with this choice.
4808 (and (not completion-no-auto-exit)
4809 (equal buffer (window-buffer (minibuffer-window)))
4810 minibuffer-completion-table
4811 ;; If this is reading a file name, and the file name chosen
4812 ;; is a directory, don't exit the minibuffer.
4813 (if (and (eq minibuffer-completion-table 'read-file-name-internal)
4814 (file-directory-p (field-string (point-max))))
4815 (let ((mini (active-minibuffer-window)))
4816 (select-window mini)
4817 (when minibuffer-auto-raise
4818 (raise-frame (window-frame mini))))
4819 (exit-minibuffer)))))))
4821 (defun completion-list-mode ()
4822 "Major mode for buffers showing lists of possible completions.
4824 to select the completion near point.
4826 with the mouse."
4827 (interactive)
4828 (kill-all-local-variables)
4829 (use-local-map completion-list-mode-map)
4830 (setq mode-name "Completion List")
4831 (setq major-mode 'completion-list-mode)
4832 (make-local-variable 'completion-base-size)
4833 (setq completion-base-size nil)
4834 (run-mode-hooks 'completion-list-mode-hook))
4836 (defun completion-list-mode-finish ()
4837 "Finish setup of the completions buffer.
4838 Called from `temp-buffer-show-hook'."
4839 (when (eq major-mode 'completion-list-mode)
4840 (toggle-read-only 1)))
4842 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
4844 (defvar completion-setup-hook nil
4845 "Normal hook run at the end of setting up a completion list buffer.
4846 When this hook is run, the current buffer is the one in which the
4847 command to display the completion list buffer was run.
4848 The completion list buffer is available as the value of `standard-output'.
4849 The common prefix substring for completion may be available as the
4850 value of `completion-common-substring'. See also `display-completion-list'.")
4853 ;; Variables and faces used in `completion-setup-function'.
4855 (defface completions-first-difference
4856 '((t (:inherit bold)))
4857 "Face put on the first uncommon character in completions in *Completions* buffer."
4858 :group 'completion)
4860 (defface completions-common-part
4861 '((t (:inherit default)))
4862 "Face put on the common prefix substring in completions in *Completions* buffer.
4863 The idea of `completions-common-part' is that you can use it to
4864 make the common parts less visible than normal, so that the rest
4865 of the differing parts is, by contrast, slightly highlighted."
4866 :group 'completion)
4868 ;; This is for packages that need to bind it to a non-default regexp
4869 ;; in order to make the first-differing character highlight work
4870 ;; to their liking
4871 (defvar completion-root-regexp "^/"
4872 "Regexp to use in `completion-setup-function' to find the root directory.")
4874 (defvar completion-common-substring nil
4875 "Common prefix substring to use in `completion-setup-function' to put faces.
4876 The value is set by `display-completion-list' during running `completion-setup-hook'.
4878 To put faces, `completions-first-difference' and `completions-common-part'
4880 needed as a hint. (Minibuffer is a special case. The content of minibuffer itself
4881 is the substring.)")
4883 ;; This function goes in completion-setup-hook, so that it is called
4884 ;; after the text of the completion list buffer is written.
4885 (defun completion-setup-function ()
4886 (let ((mainbuf (current-buffer))
4887 (mbuf-contents (minibuffer-contents)))
4888 ;; When reading a file name in the minibuffer,
4889 ;; set default-directory in the minibuffer
4890 ;; so it will get copied into the completion list buffer.
4891 (if minibuffer-completing-file-name
4892 (with-current-buffer mainbuf
4893 (setq default-directory (file-name-directory mbuf-contents))))
4894 ;; If partial-completion-mode is on, point might not be after the
4895 ;; last character in the minibuffer.
4896 ;; FIXME: This still doesn't work if the text to be completed
4897 ;; starts with a `-'.
4898 (when (and partial-completion-mode (not (eobp)))
4899 (setq mbuf-contents
4900 (substring mbuf-contents 0 (- (point) (point-max)))))
4901 (with-current-buffer standard-output
4902 (completion-list-mode)
4903 (make-local-variable 'completion-reference-buffer)
4904 (setq completion-reference-buffer mainbuf)
4905 (if minibuffer-completing-file-name
4906 ;; For file name completion,
4907 ;; use the number of chars before the start of the
4908 ;; last file name component.
4909 (setq completion-base-size
4910 (with-current-buffer mainbuf
4911 (save-excursion
4912 (goto-char (point-max))
4913 (skip-chars-backward completion-root-regexp)
4914 (- (point) (minibuffer-prompt-end)))))
4915 ;; Otherwise, in minibuffer, the whole input is being completed.
4916 (if (minibufferp mainbuf)
4917 (if (and (symbolp minibuffer-completion-table)
4918 (get minibuffer-completion-table 'completion-base-size-function))
4919 (setq completion-base-size
4920 (funcall (get minibuffer-completion-table 'completion-base-size-function)))
4921 (setq completion-base-size 0))))
4922 ;; Put faces on first uncommon characters and common parts.
4923 (when (or completion-base-size completion-common-substring)
4924 (let* ((common-string-length
4925 (if completion-base-size
4926 (- (length mbuf-contents) completion-base-size)
4927 (length completion-common-substring)))
4928 (element-start (next-single-property-change
4929 (point-min)
4930 'mouse-face))
4931 (element-common-end
4932 (and element-start
4933 (+ (or element-start nil) common-string-length)))
4934 (maxp (point-max)))
4935 (while (and element-start (< element-common-end maxp))
4936 (when (and (get-char-property element-start 'mouse-face)
4937 (get-char-property element-common-end 'mouse-face))
4938 (put-text-property element-start element-common-end
4939 'font-lock-face 'completions-common-part)
4940 (put-text-property element-common-end (1+ element-common-end)
4941 'font-lock-face 'completions-first-difference))
4942 (setq element-start (next-single-property-change
4943 element-start
4944 'mouse-face))
4945 (if element-start
4946 (setq element-common-end (+ element-start common-string-length))))))
4947 ;; Insert help string.
4948 (goto-char (point-min))
4949 (if (display-mouse-p)
4950 (insert (substitute-command-keys
4952 (insert (substitute-command-keys
4956 (add-hook 'completion-setup-hook 'completion-setup-function)
4958 (define-key minibuffer-local-completion-map [prior]
4959 'switch-to-completions)
4960 (define-key minibuffer-local-must-match-map [prior]
4961 'switch-to-completions)
4962 (define-key minibuffer-local-completion-map "\M-v"
4963 'switch-to-completions)
4964 (define-key minibuffer-local-must-match-map "\M-v"
4965 'switch-to-completions)
4967 (defun switch-to-completions ()
4968 "Select the completion list window."
4969 (interactive)
4970 ;; Make sure we have a completions window.
4971 (or (get-buffer-window "*Completions*")
4972 (minibuffer-completion-help))
4973 (let ((window (get-buffer-window "*Completions*")))
4974 (when window
4975 (select-window window)
4976 (goto-char (point-min))
4978 (forward-line 1))))
4980 ;; Support keyboard commands to turn on various modifiers.
4982 ;; These functions -- which are not commands -- each add one modifier
4983 ;; to the following event.
4985 (defun event-apply-alt-modifier (ignore-prompt)
4988 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
4989 (defun event-apply-super-modifier (ignore-prompt)
4992 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
4993 (defun event-apply-hyper-modifier (ignore-prompt)
4996 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
4997 (defun event-apply-shift-modifier (ignore-prompt)
5000 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
5001 (defun event-apply-control-modifier (ignore-prompt)
5004 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
5005 (defun event-apply-meta-modifier (ignore-prompt)
5008 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
5010 (defun event-apply-modifier (event symbol lshiftby prefix)
5011 "Apply a modifier flag to event EVENT.
5012 SYMBOL is the name of this modifier, as a symbol.
5013 LSHIFTBY is the numeric value of this modifier, in keyboard events.
5014 PREFIX is the string that represents this modifier in an event type symbol."
5015 (if (numberp event)
5016 (cond ((eq symbol 'control)
5017 (if (and (<= (downcase event) ?z)
5018 (>= (downcase event) ?a))
5019 (- (downcase event) ?a -1)
5020 (if (and (<= (downcase event) ?Z)
5021 (>= (downcase event) ?A))
5022 (- (downcase event) ?A -1)
5023 (logior (lsh 1 lshiftby) event))))
5024 ((eq symbol 'shift)
5025 (if (and (<= (downcase event) ?z)
5026 (>= (downcase event) ?a))
5027 (upcase event)
5028 (logior (lsh 1 lshiftby) event)))
5029 (t
5030 (logior (lsh 1 lshiftby) event)))
5031 (if (memq symbol (event-modifiers event))
5032 event
5033 (let ((event-type (if (symbolp event) event (car event))))
5034 (setq event-type (intern (concat prefix (symbol-name event-type))))
5035 (if (symbolp event)
5036 event-type
5037 (cons event-type (cdr event)))))))
5039 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
5040 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
5041 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
5042 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
5043 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
5044 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
5046 ;;;; Keypad support.
5048 ;;; Make the keypad keys act like ordinary typing keys. If people add
5049 ;;; bindings for the function key symbols, then those bindings will
5050 ;;; override these, so this shouldn't interfere with any existing
5051 ;;; bindings.
5053 ;; Also tell read-char how to handle these keys.
5054 (mapc
5055 (lambda (keypad-normal)
5056 (let ((keypad (nth 0 keypad-normal))
5057 (normal (nth 1 keypad-normal)))
5058 (put keypad 'ascii-character normal)
5059 (define-key function-key-map (vector keypad) (vector normal))))
5060 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
5061 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
5062 (kp-space ?\s)
5065 (kp-multiply ?*)
5066 (kp-add ?+)
5067 (kp-separator ?,)
5068 (kp-subtract ?-)
5069 (kp-decimal ?.)
5070 (kp-divide ?/)
5071 (kp-equal ?=)))
5072 \f
5073 ;;;;
5074 ;;;; forking a twin copy of a buffer.
5075 ;;;;
5077 (defvar clone-buffer-hook nil
5078 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
5080 (defun clone-process (process &optional newname)
5081 "Create a twin copy of PROCESS.
5082 If NEWNAME is nil, it defaults to PROCESS' name;
5083 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
5084 If PROCESS is associated with a buffer, the new process will be associated
5085 with the current buffer instead.
5086 Returns nil if PROCESS has already terminated."
5087 (setq newname (or newname (process-name process)))
5089 (setq newname (substring newname 0 (match-beginning 0))))
5090 (when (memq (process-status process) '(run stop open))
5091 (let* ((process-connection-type (process-tty-name process))
5092 (new-process
5093 (if (memq (process-status process) '(open))
5094 (let ((args (process-contact process t)))
5095 (setq args (plist-put args :name newname))
5096 (setq args (plist-put args :buffer
5097 (if (process-buffer process)
5098 (current-buffer))))
5099 (apply 'make-network-process args))
5100 (apply 'start-process newname
5101 (if (process-buffer process) (current-buffer))
5102 (process-command process)))))
5103 (set-process-query-on-exit-flag
5104 new-process (process-query-on-exit-flag process))
5105 (set-process-inherit-coding-system-flag
5106 new-process (process-inherit-coding-system-flag process))
5107 (set-process-filter new-process (process-filter process))
5108 (set-process-sentinel new-process (process-sentinel process))
5109 (set-process-plist new-process (copy-sequence (process-plist process)))
5110 new-process)))
5112 ;; things to maybe add (currently partly covered by `funcall mode'):
5113 ;; - syntax-table
5114 ;; - overlays
5115 (defun clone-buffer (&optional newname display-flag)
5116 "Create and return a twin copy of the current buffer.
5117 Unlike an indirect buffer, the new buffer can be edited
5118 independently of the old one (if it is not read-only).
5119 NEWNAME is the name of the new buffer. It may be modified by
5120 adding or incrementing <N> at the end as necessary to create a
5121 unique buffer name. If nil, it defaults to the name of the
5122 current buffer, with the proper suffix. If DISPLAY-FLAG is
5123 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
5124 clone a file-visiting buffer, or a buffer whose major mode symbol
5125 has a non-nil `no-clone' property, results in an error.
5127 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
5128 current buffer with appropriate suffix. However, if a prefix
5129 argument is given, then the command prompts for NEWNAME in the
5130 minibuffer.
5132 This runs the normal hook `clone-buffer-hook' in the new buffer
5133 after it has been set up properly in other respects."
5134 (interactive
5135 (progn
5136 (if buffer-file-name
5137 (error "Cannot clone a file-visiting buffer"))
5138 (if (get major-mode 'no-clone)
5139 (error "Cannot clone a buffer in %s mode" mode-name))
5140 (list (if current-prefix-arg (read-string "Name: "))
5141 t)))
5142 (if buffer-file-name
5143 (error "Cannot clone a file-visiting buffer"))
5144 (if (get major-mode 'no-clone)
5145 (error "Cannot clone a buffer in %s mode" mode-name))
5146 (setq newname (or newname (buffer-name)))
5148 (setq newname (substring newname 0 (match-beginning 0))))
5149 (let ((buf (current-buffer))
5150 (ptmin (point-min))
5151 (ptmax (point-max))
5152 (pt (point))
5153 (mk (if mark-active (mark t)))
5154 (modified (buffer-modified-p))
5155 (mode major-mode)
5156 (lvars (buffer-local-variables))
5157 (process (get-buffer-process (current-buffer)))
5158 (new (generate-new-buffer (or newname (buffer-name)))))
5159 (save-restriction
5160 (widen)
5161 (with-current-buffer new
5162 (insert-buffer-substring buf)))
5163 (with-current-buffer new
5164 (narrow-to-region ptmin ptmax)
5165 (goto-char pt)
5166 (if mk (set-mark mk))
5167 (set-buffer-modified-p modified)
5169 ;; Clone the old buffer's process, if any.
5170 (when process (clone-process process))
5172 ;; Now set up the major mode.
5173 (funcall mode)
5175 ;; Set up other local variables.
5176 (mapcar (lambda (v)
5177 (condition-case () ;in case var is read-only
5178 (if (symbolp v)
5179 (makunbound v)
5180 (set (make-local-variable (car v)) (cdr v)))
5181 (error nil)))
5182 lvars)
5184 ;; Run any hooks (typically set up by the major mode
5185 ;; for cloning to work properly).
5186 (run-hooks 'clone-buffer-hook))
5187 (if display-flag (pop-to-buffer new))
5188 new))
5191 (defun clone-indirect-buffer (newname display-flag &optional norecord)
5192 "Create an indirect buffer that is a twin copy of the current buffer.
5194 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
5195 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
5196 or if not called with a prefix arg, NEWNAME defaults to the current
5197 buffer's name. The name is modified by adding a `<N>' suffix to it
5198 or by incrementing the N in an existing suffix.
5200 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
5201 This is always done when called interactively.
5203 Optional third arg NORECORD non-nil means do not put this buffer at the
5204 front of the list of recently selected ones."
5205 (interactive
5206 (progn
5207 (if (get major-mode 'no-clone-indirect)
5208 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
5209 (list (if current-prefix-arg
5210 (read-string "BName of indirect buffer: "))
5211 t)))
5212 (if (get major-mode 'no-clone-indirect)
5213 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
5214 (setq newname (or newname (buffer-name)))
5216 (setq newname (substring newname 0 (match-beginning 0))))
5217 (let* ((name (generate-new-buffer-name newname))
5218 (buffer (make-indirect-buffer (current-buffer) name t)))
5219 (when display-flag
5220 (pop-to-buffer buffer norecord))
5221 buffer))
5224 (defun clone-indirect-buffer-other-window (buffer &optional norecord)
5225 "Create an indirect buffer that is a twin copy of BUFFER.
5226 Select the new buffer in another window.
5227 Optional second arg NORECORD non-nil means do not put this buffer at
5228 the front of the list of recently selected ones."
5229 (interactive "bClone buffer in other window: ")
5230 (let ((pop-up-windows t))
5231 (set-buffer buffer)
5232 (clone-indirect-buffer nil t norecord)))
5234 \f
5235 ;;; Handling of Backspace and Delete keys.
5237 (defcustom normal-erase-is-backspace
5238 (and (not noninteractive)
5239 (or (memq system-type '(ms-dos windows-nt))
5240 (eq window-system 'mac)
5241 (and (memq window-system '(x))
5242 (fboundp 'x-backspace-delete-keys-p)
5243 (x-backspace-delete-keys-p))
5244 ;; If the terminal Emacs is running on has erase char
5245 ;; set to ^H, use the Backspace key for deleting
5246 ;; backward and, and the Delete key for deleting forward.
5247 (and (null window-system)
5248 (eq tty-erase-char ?\^H))))
5249 "If non-nil, Delete key deletes forward and Backspace key deletes backward.
5251 On window systems, the default value of this option is chosen
5252 according to the keyboard used. If the keyboard has both a Backspace
5253 key and a Delete key, and both are mapped to their usual meanings, the
5254 option's default value is set to t, so that Backspace can be used to
5255 delete backward, and Delete can be used to delete forward.
5257 If not running under a window system, customizing this option accomplishes
5258 a similar effect by mapping C-h, which is usually generated by the
5259 Backspace key, to DEL, and by mapping DEL to C-d via
5260 `keyboard-translate'. The former functionality of C-h is available on
5261 the F1 key. You should probably not use this setting if you don't
5262 have both Backspace, Delete and F1 keys.
5264 Setting this variable with setq doesn't take effect. Programmatically,
5265 call `normal-erase-is-backspace-mode' (which see) instead."
5266 :type 'boolean
5267 :group 'editing-basics
5268 :version "21.1"
5269 :set (lambda (symbol value)
5270 ;; The fboundp is because of a problem with :set when
5271 ;; dumping Emacs. It doesn't really matter.
5272 (if (fboundp 'normal-erase-is-backspace-mode)
5273 (normal-erase-is-backspace-mode (or value 0))
5274 (set-default symbol value))))
5277 (defun normal-erase-is-backspace-mode (&optional arg)
5278 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
5280 With numeric arg, turn the mode on if and only if ARG is positive.
5282 On window systems, when this mode is on, Delete is mapped to C-d and
5283 Backspace is mapped to DEL; when this mode is off, both Delete and
5284 Backspace are mapped to DEL. (The remapping goes via
5285 `function-key-map', so binding Delete or Backspace in the global or
5286 local keymap will override that.)
5288 In addition, on window systems, the bindings of C-Delete, M-Delete,
5289 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
5290 the global keymap in accordance with the functionality of Delete and
5291 Backspace. For example, if Delete is remapped to C-d, which deletes
5292 forward, C-Delete is bound to `kill-word', but if Delete is remapped
5293 to DEL, which deletes backward, C-Delete is bound to
5294 `backward-kill-word'.
5296 If not running on a window system, a similar effect is accomplished by
5297 remapping C-h (normally produced by the Backspace key) and DEL via
5298 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
5299 to C-d; if it's off, the keys are not remapped.
5301 When not running on a window system, and this mode is turned on, the
5302 former functionality of C-h is available on the F1 key. You should
5303 probably not turn on this mode on a text-only terminal if you don't
5304 have both Backspace, Delete and F1 keys.
5306 See also `normal-erase-is-backspace'."
5307 (interactive "P")
5308 (setq normal-erase-is-backspace
5309 (if arg
5310 (> (prefix-numeric-value arg) 0)
5311 (not normal-erase-is-backspace)))
5313 (cond ((or (memq window-system '(x w32 mac pc))
5314 (memq system-type '(ms-dos windows-nt)))
5315 (let ((bindings
5316 `(([C-delete] [C-backspace])
5317 ([M-delete] [M-backspace])
5318 ([C-M-delete] [C-M-backspace])
5319 (,esc-map
5320 [C-delete] [C-backspace])))
5321 (old-state (lookup-key function-key-map [delete])))
5323 (if normal-erase-is-backspace
5324 (progn
5325 (define-key function-key-map [delete] [?\C-d])
5326 (define-key function-key-map [kp-delete] [?\C-d])
5327 (define-key function-key-map [backspace] [?\C-?]))
5328 (define-key function-key-map [delete] [?\C-?])
5329 (define-key function-key-map [kp-delete] [?\C-?])
5330 (define-key function-key-map [backspace] [?\C-?]))
5332 ;; Maybe swap bindings of C-delete and C-backspace, etc.
5333 (unless (equal old-state (lookup-key function-key-map [delete]))
5334 (dolist (binding bindings)
5335 (let ((map global-map))
5336 (when (keymapp (car binding))
5337 (setq map (car binding) binding (cdr binding)))
5338 (let* ((key1 (nth 0 binding))
5339 (key2 (nth 1 binding))
5340 (binding1 (lookup-key map key1))
5341 (binding2 (lookup-key map key2)))
5342 (define-key map key1 binding2)
5343 (define-key map key2 binding1)))))))
5344 (t
5345 (if normal-erase-is-backspace
5346 (progn
5347 (keyboard-translate ?\C-h ?\C-?)
5348 (keyboard-translate ?\C-? ?\C-d))
5349 (keyboard-translate ?\C-h ?\C-h)
5350 (keyboard-translate ?\C-? ?\C-?))))
5352 (run-hooks 'normal-erase-is-backspace-hook)
5353 (if (interactive-p)
5354 (message "Delete key deletes %s"
5355 (if normal-erase-is-backspace "forward" "backward"))))
5356 \f
5357 (defvar vis-mode-saved-buffer-invisibility-spec nil
5358 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
5360 (define-minor-mode visible-mode
5361 "Toggle Visible mode.
5362 With argument ARG turn Visible mode on iff ARG is positive.
5364 Enabling Visible mode makes all invisible text temporarily visible.
5365 Disabling Visible mode turns off that effect. Visible mode
5366 works by saving the value of `buffer-invisibility-spec' and setting it to nil."
5367 :lighter " Vis"
5368 :group 'editing-basics
5369 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
5370 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
5371 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
5372 (when visible-mode
5373 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
5374 buffer-invisibility-spec)
5375 (setq buffer-invisibility-spec nil)))
5376 \f
5377 ;; Minibuffer prompt stuff.
5379 ;(defun minibuffer-prompt-modification (start end)
5380 ; (error "You cannot modify the prompt"))
5381 ;
5382 ;
5383 ;(defun minibuffer-prompt-insertion (start end)
5384 ; (let ((inhibit-modification-hooks t))
5385 ; (delete-region start end)
5386 ; ;; Discard undo information for the text insertion itself
5387 ; ;; and for the text deletion.above.
5388 ; (when (consp buffer-undo-list)
5389 ; (setq buffer-undo-list (cddr buffer-undo-list)))
5390 ; (message "You cannot modify the prompt")))
5391 ;
5392 ;
5393 ;(setq minibuffer-prompt-properties
5394 ; (list 'modification-hooks '(minibuffer-prompt-modification)
5395 ; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
5396 ;
5398 (provide 'simple)
5400 ;; arch-tag: 24af67c0-2a49-44f6-b3b1-312d8b570dfd
5401 ;;; simple.el ends here