| blob | 4db0aae25ad0d17a57384bf20cda5ec19012f32c |
1 ;;; simple.el --- basic editing commands for Emacs
3 ;; Copyright (C) 1985-1987, 1993-2011 Free Software Foundation, Inc.
5 ;; Maintainer: FSF
6 ;; Keywords: internal
7 ;; Package: emacs
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 3 of the License, or
14 ;; (at your option) 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. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; A grab-bag of basic Emacs commands not specifically related to some
27 ;; major mode or to file-handling.
29 ;;; Code:
36 ;;; From compile.el
41 "Idle time delay before updating various things on the screen.
42 Various Emacs features that update auxiliary information when point moves
43 wait this many seconds after Emacs becomes idle before doing an update."
49 "Killing and yanking commands."
53 "Highlight (un)matching of parens and expressions."
55 \f
56 ;;; next-error support framework
59 "`next-error' support framework."
65 "Face used to highlight next error locus."
70 "Highlighting of locations in selected source buffers.
71 If a number, highlight the locus in `next-error' face for the given time
72 in seconds, or until the next command is executed.
73 If t, highlight the locus until the next command is executed, or until
74 some other locus replaces it.
75 If nil, don't highlight the locus in the source buffer.
76 If `fringe-arrow', indicate the locus by the fringe arrow
77 indefinitely until some other locus replaces it."
86 "Highlighting of locations in `next-error-no-select'.
87 If number, highlight the locus in `next-error' face for given time in seconds.
88 If t, highlight the locus indefinitely until some other locus replaces it.
89 If nil, don't highlight the locus in the source buffer.
90 If `fringe-arrow', indicate the locus by the fringe arrow
91 indefinitely until some other locus replaces it."
100 "Display the line in the visited source file recentered as specified.
101 If non-nil, the value is passed directly to `recenter'."
109 "List of hook functions run by `next-error' after visiting source file."
120 "The most recent `next-error' buffer.
121 A buffer becomes most recent when its compilation, grep, or
126 "Function to use to find the next error in the current buffer.
127 The function is called with 2 parameters:
128 ARG is an integer specifying by how many errors to move.
129 RESET is a boolean which, if non-nil, says to go back to the beginning
130 of the errors before moving.
131 Major modes providing compile-like functionality should set this variable
132 to indicate to `next-error' that this is a candidate buffer and how
137 "Function to use to move to an error locus.
138 It takes two arguments, a buffer position in the error buffer
139 and a buffer position in the error locus buffer.
140 The buffer for the error locus should already be current.
145 &optional avoid-current
146 extra-test-inclusive
147 extra-test-exclusive)
148 "Test if BUFFER is a `next-error' capable buffer.
150 If AVOID-CURRENT is non-nil, treat the current buffer
151 as an absolute last resort only.
153 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
154 that normally would not qualify. If it returns t, the buffer
155 in question is treated as usable.
157 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
158 that would normally be considered usable. If it returns nil,
159 that buffer is rejected."
164 ;; Optionally reject some buffers.
167 t)
168 ;; Optionally accept some other buffers.
173 extra-test-inclusive
174 extra-test-exclusive)
175 "Return a `next-error' capable buffer.
177 If AVOID-CURRENT is non-nil, treat the current buffer
178 as an absolute last resort only.
180 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
181 that normally would not qualify. If it returns t, the buffer
182 in question is treated as usable.
184 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
185 that would normally be considered usable. If it returns nil,
186 that buffer is rejected."
188 ;; 1. If one window on the selected frame displays such buffer, return it.
194 avoid-current
195 extra-test-inclusive extra-test-exclusive)
200 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
203 extra-test-inclusive extra-test-exclusive))
204 next-error-last-buffer)
205 ;; 3. If the current buffer is acceptable, choose it.
207 extra-test-inclusive extra-test-exclusive)
209 ;; 4. Look for any acceptable buffer.
214 extra-test-inclusive extra-test-exclusive)))
217 ;; 5. Use the current buffer as a last resort if it qualifies,
218 ;; even despite AVOID-CURRENT.
221 extra-test-inclusive extra-test-exclusive)
225 ;; 6. Give up.
229 "Visit next `next-error' message and corresponding source code.
231 If all the error messages parsed so far have been processed already,
232 the message buffer is checked for new ones.
234 A prefix ARG specifies how many error messages to move;
235 negative means move back to previous error messages.
237 and start at the first error.
239 The RESET argument specifies that we should restart from the beginning.
242 compilation, grep, or occur buffer. It can also operate on any
244 more generally, on any buffer in Compilation mode or with
245 Compilation Minor mode enabled, or any buffer in which
246 `next-error-function' is bound to an appropriate function.
247 To specify use of a particular buffer for error messages, type
249 in the current frame.
252 runs `next-error-hook' with `run-hooks', and stays with that buffer
253 until you use it in some other buffer which uses Compilation mode
254 or Compilation Minor mode.
256 To control which errors are matched, customize the variable
257 `compilation-error-regexp-alist'."
261 ;; we know here that next-error-function is a valid symbol we can funcall
269 "Visit the source code corresponding to the `next-error' message at point."
271 ;; we know here that next-error-function is a valid symbol we can funcall
282 "Visit previous `next-error' message and corresponding source code.
284 Prefix arg N says how many error messages to move backwards (or
285 forwards, if negative).
292 "Restart at the first error.
293 Visit corresponding source code.
294 With prefix arg N, visit the source code of the Nth error.
300 "Move point to the next error in the `next-error' buffer and highlight match.
301 Prefix arg N says how many error messages to move forwards (or
302 backwards, if negative).
304 select the source buffer."
311 "Move point to the previous error in the `next-error' buffer and highlight match.
312 Prefix arg N says how many error messages to move backwards (or
313 forwards, if negative).
315 select the source buffer."
319 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
323 "Minor mode for compilation, occur and diff modes.
324 When turned on, cursor motion in the compilation, grep, occur or diff
325 buffer causes automatic display of the corresponding source code
326 location."
333 ;; Used as a `post-command-hook' by `next-error-follow-mode'
334 ;; for the *Compilation* *grep* and *Occur* buffers.
344 \f
345 ;;;
348 "Major mode not specialized for anything in particular.
349 Other major modes are defined by comparison with this one."
354 ;; Special major modes to view specially formatted data rather than files.
368 map))
372 "Parent major mode from which special major modes should inherit."
375 ;; Major mode meant to be the parent of programming modes.
380 map)
384 "Indent the expression after point."
391 "Major mode for editing programming language source code."
394 ;; Any programming language is always written left to right.
397 ;; Making and deleting lines.
403 "Insert a newline, and move to left margin of the new line if it's blank.
404 If `use-hard-newlines' is non-nil, the newline is marked with the
405 text-property `hard'.
406 With ARG, insert that many newlines.
407 Call `auto-fill-function' if the current column number is greater
408 than the value of `fill-column' and ARG is nil."
411 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
412 ;; Set last-command-event to tell self-insert what to insert.
416 ;; Don't auto-fill if we have a numeric argument.
419 ;; Do the rest in post-self-insert-hook, because we want to do it
420 ;; *before* other functions on that hook.
422 ;; Mark the newline(s) `hard'.
426 ;; If the newline leaves the previous line blank, and we
427 ;; have a left margin, delete that from the blank line.
435 ;; Indent the line after the newline, except in one case:
436 ;; when we added the newline at the beginning of a line which
437 ;; starts a page.
444 ;; We first used let-binding to protect the hook, but that was naive
445 ;; since add-hook affects the symbol-default value of the variable,
446 ;; whereas the let-binding might only protect the buffer-local value.
448 nil)
453 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
459 "Insert a newline and leave point before it.
460 If there is a fill prefix and/or a `left-margin', insert them
461 on the new line if the line would have been blank.
462 With arg N, insert N newlines."
467 ;; Don't expand an abbrev before point.
481 "Split current line, moving portion beyond point vertically down.
482 If the current line starts with `fill-prefix', insert it on the new
483 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
485 When called from Lisp code, ARG may be a prefix string to copy."
490 ;; What prefix should we check for (nil means don't).
494 ;; Does this line start with it?
505 "Join this line to previous and fix up whitespace at join.
506 If there is a fill prefix, delete it from the beginning of this line.
507 With argument, join this line to following line."
514 ;; If the second line started with the fill prefix,
515 ;; delete the prefix.
527 "On blank line, delete all surrounding blank lines, leaving just one.
528 On isolated blank line, delete that one.
529 On nonblank line, delete any immediately following blank lines."
535 ;; Set singleblank if there is just one blank line here.
542 ;; Delete preceding blank lines, and this one too if it's the only one.
551 ;; Delete following blank lines, unless the current line is blank
552 ;; and there are no following blank lines.
561 ;; Handle the special case where point is followed by newline and eob.
562 ;; Delete the line, leaving point at eob.
567 "Delete all the trailing whitespace across the current buffer.
568 All whitespace after the last non-whitespace character in a line is deleted.
570 A formfeed is not considered whitespace by this function.
571 If the region is active, only delete whitespace within the region."
584 ;; Don't delete formfeeds, even if they are considered whitespace.
590 ;; Return nil for the benefit of `write-file-functions'.
591 nil)
594 "Insert a newline, then indent according to major mode.
595 Indentation is done using the value of `indent-line-function'.
596 In programming language modes, this is the same as TAB.
597 In some text modes, where TAB inserts a tab, this command indents to the
598 column specified by the function `current-left-margin'."
605 "Reindent current line, insert newline, then indent the new line.
606 Indentation of both lines is done according to the current major mode,
607 which means calling the current value of `indent-line-function'.
608 In programming language modes, this is the same as TAB.
609 In some text modes, where TAB inserts a tab, this indents to the
610 column specified by the function `current-left-margin'."
613 ;; Be careful to insert the newline before indenting the line.
614 ;; Otherwise, the indentation might be wrong.
618 ;; We are at EOL before the call to indent-according-to-mode, and
619 ;; after it we usually are as well, but not always. We tried to
620 ;; address it with `save-excursion' but that uses a normal marker
621 ;; whereas we need `move after insertion', so we do the save/restore
622 ;; by hand.
626 ;; Remove the trailing white-space after indentation because
627 ;; indentation may introduce the whitespace.
632 "Read next input character and insert it.
633 This is useful for inserting control characters.
634 With argument, insert ARG copies of the character.
636 If the first character you type after this command is an octal digit,
637 you should type a sequence of octal digits which specify a character code.
638 Any nondigit terminates the sequence. If the terminator is a RET,
639 it is discarded; any other terminator is used itself as input.
640 The variable `read-quoted-char-radix' specifies the radix for this feature;
641 set it to 10 or 16 to use decimal or hex instead of octal.
643 In overwrite mode, this function inserts the character anyway, and
644 does not handle octal digits specially. This means that if you use
645 overwrite as your normal editing mode, you can use this function to
646 insert characters when necessary.
648 In binary overwrite mode, this function does overwrite, and octal
649 digits are interpreted as a character code. This is intended to be
650 useful for editing binary files."
653 ;; Avoid "obsolete" warnings for translation-table-for-input.
660 ;; This used to assume character codes 0240 - 0377 stand for
661 ;; characters in some single-byte character set, and converted them
662 ;; to Emacs characters. But in 23.1 this feature is deprecated
663 ;; in favor of inserting the corresponding Unicode characters.
664 ;; (if (and enable-multibyte-characters
665 ;; (>= char ?\240)
666 ;; (<= char ?\377))
667 ;; (setq char (unibyte-char-to-multibyte char)))
676 "Move forward ARG lines and position at first nonblank character."
682 "Move backward ARG lines and position at first nonblank character."
688 "Move point to the first non-whitespace character on this line."
692 ;; Move back over chars that have whitespace syntax but have the p flag.
696 "Fixup white space between objects around point.
697 Leave one space or none, according to the context."
704 nil
708 "Delete all spaces and tabs around point.
709 If BACKWARD-ONLY is non-nil, only delete them before point."
714 orig-pos
723 "Delete all spaces and tabs around point, leaving one space (or N spaces).
724 If N is negative, delete newlines as well."
741 \f
743 "Move point to the beginning of the buffer.
744 With numeric arg N, put point N/10 of the way from the beginning.
745 If the buffer is narrowed, this command uses the beginning of the
746 accessible part of the buffer.
748 If Transient Mark mode is disabled, leave mark at previous
751 Don't use this command in Lisp programs!
752 \(goto-char (point-min)) is faster."
761 ;; Avoid overflow for large buffer sizes!
769 "Move point to the end of the buffer.
770 With numeric arg N, put point N/10 of the way from the end.
771 If the buffer is narrowed, this command uses the end of the
772 accessible part of the buffer.
774 If Transient Mark mode is disabled, leave mark at previous
777 Don't use this command in Lisp programs!
778 \(goto-char (point-max)) is faster."
785 ;; Avoid overflow for large buffer sizes!
790 ;; If we went to a place in the middle of the buffer,
791 ;; adjust it to the beginning of a line.
794 ;; If the end of the buffer is not already on the screen,
795 ;; then scroll specially to put it near, but not at, the bottom.
800 "Whether single-char deletion commands delete an active region.
801 This has an effect only if Transient Mark mode is enabled, and
802 affects `delete-forward-char' and `delete-backward-char', though
803 not `delete-char'.
805 If the value is the symbol `kill', the active region is killed
806 instead of deleted."
814 "Delete the previous N characters (following if N is negative).
815 If Transient Mark mode is enabled, the mark is active, and N is 1,
816 delete the text in the region and deactivate the mark instead.
817 To disable this, set `delete-active-region' to nil.
819 Optional second arg KILLFLAG, if non-nil, means to kill (save in
820 kill ring) instead of delete. Interactively, N is the prefix
821 arg, and KILLFLAG is set if N is explicitly specified.
823 In Overwrite mode, single character backward deletion may replace
824 tabs with spaces so as to back over columns, unless point is at
825 the end of the line."
830 delete-active-region
832 ;; If a region is active, kill or delete it.
836 ;; In Overwrite mode, maybe untabify while deleting
846 ;; Otherwise, do simple deletion.
850 "Delete the following N characters (previous if N is negative).
851 If Transient Mark mode is enabled, the mark is active, and N is 1,
852 delete the text in the region and deactivate the mark instead.
853 To disable this, set `delete-active-region' to nil.
855 Optional second arg KILLFLAG non-nil means to kill (save in kill
856 ring) instead of delete. Interactively, N is the prefix arg, and
857 KILLFLAG is set if N was explicitly specified."
862 delete-active-region
864 ;; If a region is active, kill or delete it.
868 ;; Otherwise, do simple deletion.
872 "Put point at beginning and mark at end of buffer.
873 You probably should not use this function in Lisp programs;
874 it is usually a mistake for a Lisp function to use any subroutine
875 that uses or sets the mark."
880 \f
882 ;; Counting lines, one way or another.
885 "Goto LINE, counting from line 1 at beginning of buffer.
886 Normally, move point in the current buffer, and leave mark at the
888 move point in the most recently selected other buffer, and switch to it.
890 If there's a number in the buffer at point, it is the default for LINE.
892 This function is usually the wrong thing to use in a Lisp program.
893 What you probably want instead is something like:
894 (goto-char (point-min)) (forward-line (1- N))
895 If at all possible, an even better solution is to use char counts
896 rather than line counts."
900 ;; Look for a default, a number in the buffer at point.
910 ;; Decide if we're switching buffers.
918 ;; Read the argument, offering that number (if any) as default.
921 buffer-prompt
922 default)
923 default)
924 buffer))))
925 ;; Switch to the desired buffer, one way or another.
930 ;; Leave mark at previous position
932 ;; Move to the specified line number in that buffer.
941 "Count the number of words in the active region.
942 If the region is not active, counts the number of words in the buffer."
955 count))
956 count))
959 "Print number of lines and characters in the region."
965 "Print the current buffer line number and narrowed line number of point."
978 "Return number of lines between START and END.
979 This is usually the number of newlines between them,
980 but can be one more if START is not equal to END
981 and the greater of them is not at the start of a line."
997 done)))
1001 "Return (narrowed) buffer line number at position POS.
1002 If POS is nil, use current buffer location.
1003 Counting starts at (point-min), so the value refers
1004 to the contents of the accessible portion of the buffer."
1014 "Print info on cursor position (on screen and within buffer).
1015 Also describe the character after point, and give its character code
1016 in octal, decimal and hex.
1018 For a non-ASCII multibyte character, also give its encoding in the
1019 buffer's selected coding system if the coding system encodes the
1020 character safely. If the character is encoded into one byte, that
1021 code is shown in hex. If the character is encoded into more than one
1024 In addition, with prefix argument, show details about that character
1025 in *Help* buffer. See also the command `describe-char'."
1033 ;; Avoid overflow from multiplying by 100!
1037 ""
1043 pos total percent beg end col hscroll)
1045 pos total col hscroll))
1047 encoded encoding-msg display-prop under-display)
1054 ;; Check if the character is displayed with some `display'
1055 ;; text property. In that case, set under-display to the
1056 ;; buffer substring covered by that property.
1067 under-display)))
1073 char char char under-display)
1075 char char char under-display display-prop))
1078 char char char
1080 "..."
1084 ;; We show the detailed information about CHAR.
1091 encoding-msg pos total percent beg end col hscroll)
1098 encoding-msg pos total percent col hscroll))))))
1099 \f
1100 ;; Initialize read-expression-map. It is defined at C level.
1103 ;; Might as well bind TAB to completion, since inserting a TAB char is much
1104 ;; too rarely useful.
1114 "The current default value or list of default values in the minibuffer.
1115 The functions `read-from-minibuffer' and `completing-read' bind
1119 "Value for `print-level' while printing value in `eval-expression'.
1120 A value of nil means no limit."
1126 "Value for `print-length' while printing value in `eval-expression'.
1127 A value of nil means no limit."
1133 "If non-nil set `debug-on-error' to t in `eval-expression'.
1134 If nil, don't change the value of `debug-on-error'."
1140 "Format VALUE as a result of evaluated expression.
1141 Return a formatted string which is displayed in the echo area
1142 in addition to the value printed by prin1 in functions which
1143 display the result of expression evaluation."
1156 ;; We define this, rather than making `eval' interactive,
1157 ;; for the sake of completion of names like eval-region, eval-buffer.
1160 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
1161 When called interactively, read an Emacs Lisp expression and
1162 evaluate it.
1163 Value is also consed on to front of the variable `values'.
1164 Optional argument EVAL-EXPRESSION-INSERT-VALUE non-nil (interactively,
1165 with prefix argument) means insert the result into the current buffer
1166 instead of printing it in the echo area. Truncates long output
1167 according to the value of the variables `eval-expression-print-length'
1168 and `eval-expression-print-level'.
1170 If `eval-expression-debug-on-error' is non-nil, which is the default,
1171 this command arranges for all errors to enter the debugger."
1175 nil read-expression-map t
1177 current-prefix-arg))
1182 ;; Bind debug-on-error to something unique so that we can
1183 ;; detect when evaled code changes it.
1187 ;; If evaled code has changed the value of debug-on-error,
1188 ;; propagate that change to the global binding.
1204 "Prompting with PROMPT, let user edit COMMAND and eval result.
1205 COMMAND is a Lisp expression. Let user edit that expression in
1206 the minibuffer, then read and evaluate the result."
1213 read-expression-map t
1215 ;; If command was added to command-history as a string,
1216 ;; get rid of that. We want only evaluable expressions there.
1220 ;; If command to be redone does not match front of history,
1221 ;; add it to the history.
1227 "Edit and re-evaluate last complex command, or ARGth from last.
1228 A complex command is one which used the minibuffer.
1229 The command is placed in the minibuffer as a Lisp form for editing.
1230 The result is executed, repeating the command as changed.
1231 If the command has been changed or is not the most recent previous
1232 command it is added to the front of the command history.
1233 You can use the minibuffer history commands \
1235 to get different commands to edit and resubmit."
1238 newcmd)
1250 ;; If command was added to command-history as a
1251 ;; string, get rid of that. We want only
1252 ;; evaluable expressions there.
1256 ;; If command to be redone does not match front of history,
1257 ;; add it to the history.
1266 "Read command name to invoke in `execute-extended-command'."
1271 ;; Get a command name at point in the original buffer
1272 ;; to propose it after M-n.
1276 ;; Read a string, completing from and restricting to the set of
1277 ;; all defined commands. Don't provide any initial input.
1278 ;; Save the command read on the extended-command history list.
1289 ;; This isn't strictly correct if `execute-extended-command'
1290 ;; is bound to anything else (e.g. [menu]).
1291 ;; It could use (key-description (this-single-command-keys)),
1292 ;; but actually a prompt other than "M-x" would be confusing,
1293 ;; because "M-x" is a well-known prompt to read a command
1294 ;; and it serves as a shorthand for "Extended command: ".
1298 \f
1300 "Default minibuffer history list.
1301 This is used for all minibuffer input
1302 except when an alternate history list is specified.
1304 Maximum length of the history list is determined by the value
1307 "Control whether history list elements are expressions or strings.
1308 If the value of this variable equals current minibuffer depth,
1309 they are expressions; otherwise they are strings.
1310 \(That convention is designed to do the right thing for
1317 "Text that was in this minibuffer before any history commands.
1318 This is nil if there have not yet been any history commands
1327 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1331 "Minibuffer history variables for which matching should ignore case.
1332 If a history variable is a member of this list, then the
1334 commands ignore case when searching it, regardless of `case-fold-search'."
1339 "Find the previous history element that matches REGEXP.
1340 \(Previous history elements refer to earlier actions.)
1341 With prefix argument N, search for Nth previous match.
1342 If N is negative, find the next or Nth next match.
1343 Normally, history elements are matched case-insensitively if
1344 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1345 makes the search case-sensitive.
1346 See also `minibuffer-history-case-insensitive-variables'."
1350 nil
1351 minibuffer-local-map
1352 nil
1353 'minibuffer-history-search-history
1355 ;; Use the last regexp specified, by default, if input is empty.
1360 regexp)
1370 ;; On some systems, ignore case for file names.
1372 minibuffer-history-case-insensitive-variables)
1373 t
1374 ;; Respect the user's setting for case-fold-search:
1375 case-fold-search)
1376 nil))
1377 prevpos
1378 match-string
1379 match-offset
1386 "No later matching history item"
1407 next-matching-history-element))
1411 "Find the next history element that matches REGEXP.
1412 \(The next history element refers to a more recent action.)
1413 With prefix argument N, search for Nth next match.
1414 If N is negative, find the previous or Nth previous match.
1415 Normally, history elements are matched case-insensitively if
1416 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1417 makes the search case-sensitive."
1421 nil
1422 minibuffer-local-map
1423 nil
1424 'minibuffer-history-search-history
1426 ;; Use the last regexp specified, by default, if input is empty.
1431 regexp)
1438 "Function run by `goto-history-element' before consuming default values.
1439 This is useful to dynamically add more elements to the list of default values
1440 when `goto-history-element' reaches the end of this list.
1441 Before calling this function `goto-history-element' sets the variable
1442 `minibuffer-default-add-done' to t, so it will call this function only
1443 once. In special cases, when this function needs to be called more
1444 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1448 "When nil, add more elements to the end of the list of default values.
1449 The value nil causes `goto-history-element' to add more elements to
1450 the list of defaults when it reaches the end of this list. It does
1456 "Return a list of all completions without the default value.
1457 This function is used to add all elements of the completion table to
1458 the end of the list of defaults just after the default value."
1461 minibuffer-completion-table
1462 minibuffer-completion-predicate)))
1468 "Puts element of the minibuffer history in the minibuffer.
1469 The argument NABS specifies the absolute history position."
1483 elt minibuffer-returned-to-present)
1495 previous-history-element))
1507 minibuffer-default)))
1519 elt))
1523 "Puts next element of the minibuffer history in the minibuffer.
1524 With argument N, it uses the Nth following element."
1530 "Puts previous element of the minibuffer history in the minibuffer.
1531 With argument N, it uses the Nth previous element."
1537 "Get next history element which completes the minibuffer before the point.
1538 The contents of the minibuffer after the point are deleted, and replaced
1539 by the new completion."
1545 n)
1546 ;; next-matching-history-element always puts us at (point-min).
1547 ;; Move to the position we were at before changing the buffer contents.
1548 ;; This is still sensical, because the text before point has not changed.
1552 "\
1553 Get previous history element which completes the minibuffer before the point.
1554 The contents of the minibuffer after the point are deleted, and replaced
1555 by the new completion."
1559 ;; For compatibility with the old subr of the same name.
1561 "Return the display width of the minibuffer prompt.
1562 Return 0 if current buffer is not a minibuffer."
1563 ;; Return the width of everything before the field at the end of
1564 ;; the buffer; this should be 0 for normal buffers.
1566 \f
1567 ;; isearch minibuffer history
1574 "Set up a minibuffer for using isearch to search the minibuffer history.
1575 Intended to be added to `minibuffer-setup-hook'."
1587 "Clean up the minibuffer after terminating isearch in the minibuffer."
1592 "Return the proper search function, for isearch in minibuffer history."
1599 ;; Use standard functions to search within minibuffer text
1605 found)
1606 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1607 ;; searching forward. Lazy-highlight calls this lambda with the
1608 ;; bound arg, so skip the minibuffer prompt.
1612 ;; 1. First try searching in the initial minibuffer text
1615 noerror)
1616 ;; 2. If the above search fails, start putting next/prev history
1617 ;; elements in the minibuffer successively, and search the string
1618 ;; in them. Do this only when bound is nil (i.e. not while
1619 ;; lazy-highlighting search strings in the current minibuffer text).
1631 ;; After putting the next/prev history element, search
1632 ;; the string in them again, until next-history-element
1633 ;; or previous-history-element raises an error at the
1634 ;; beginning/end of history.
1637 ;; For backward search, don't search
1638 ;; in the minibuffer prompt
1640 noerror)))
1641 ;; Return point of the new search result
1643 ;; Return nil when next(prev)-history-element fails
1647 "Display the minibuffer history search prompt.
1648 If there are no search errors, this function displays an overlay with
1649 the isearch prompt which replaces the original minibuffer prompt.
1650 Otherwise, it displays the standard isearch message returned from
1651 `isearch-message'."
1653 ;; Use standard function `isearch-message' when not in the minibuffer,
1654 ;; or search fails, or has an error (like incomplete regexp).
1655 ;; This function overwrites minibuffer text with isearch message,
1656 ;; so it's possible to see what is wrong in the search string.
1658 ;; Otherwise, put the overlay with the standard isearch prompt over
1659 ;; the initial minibuffer prompt.
1668 ;; And clear any previous isearch message.
1672 "Wrap the minibuffer history search when search fails.
1673 Move point to the first history element for a forward search,
1674 or to the last history element for a backward search."
1676 ;; When `minibuffer-history-isearch-search' fails on reaching the
1677 ;; beginning/end of the history, wrap the search to the first/last
1678 ;; minibuffer history element.
1686 "Save a function restoring the state of minibuffer history search.
1687 Save `minibuffer-history-position' to the additional state parameter
1688 in the search status stack."
1693 "Restore the minibuffer history search state.
1694 Go to the history element by the absolute history position HIST-POS."
1697 \f
1698 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1702 "Table mapping redo records to the corresponding undo one.
1703 A redo record for undo-in-region maps to t.
1713 "Within a run of consecutive undo commands, list remaining to be undone.
1717 "Undo some previous changes.
1718 Repeat this command to undo more changes.
1719 A numeric ARG serves as a repeat count.
1721 In Transient Mark mode when the mark is active, only undo changes within
1723 as an argument limits undo to changes within the current region."
1725 ;; Make last-command indicate for the next command that this was an undo.
1726 ;; That way, another undo will undo more.
1727 ;; If we get to the end of the undo history and get an error,
1728 ;; another undo command will find the undo history empty
1729 ;; and will get another error. To begin undoing the undos,
1730 ;; you must type some other command.
1733 message)
1734 ;; If we get an error in undo-start,
1735 ;; the next command should not be a "consecutive undo".
1736 ;; So set `this-command' to something other than `undo'.
1741 ;; If something (a timer or filter?) changed the buffer
1742 ;; since the previous command, don't continue the undo seq.
1746 ;; If the last undo record made was made by undo
1747 ;; it shows nothing else happened in between.
1754 ;; get rid of initial undo boundary
1756 ;; If we got this far, the next command should be a consecutive undo.
1758 ;; Check to see whether we're hitting a redo record, and if
1759 ;; so, ask the user whether she wants to skip the redo/undo pair.
1766 ;; The equiv entry might point to another redo record if we have done
1767 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1775 ;; Record the fact that the just-generated undo records come from an
1776 ;; undo operation--that is, they are redo records.
1777 ;; In the ordinary case (not within a region), map the redo
1778 ;; record to the following undos.
1779 ;; I don't know how to do that in the undo-in-region case.
1781 ;; Strip any leading undo boundaries there might be, like we do
1782 ;; above when checking.
1786 undo-equiv-table))
1787 ;; Don't specify a position in the undo record for the undo command.
1788 ;; Instead, undoing this should move point to where the change is.
1807 ;; Record what the current undo list says,
1808 ;; so the next command can tell if the buffer was modified in between.
1811 ;; Display a message announcing success.
1816 "Make BUFFER stop keeping undo information.
1817 No argument or nil as argument means do this for the current buffer."
1823 "Undo some previous changes.
1824 Repeat this command to undo more changes.
1825 A numeric ARG serves as a repeat count.
1826 Contrary to `undo', this will not redo a previous undo."
1831 "Non-nil while performing an undo.
1835 "Undo back N undo-boundaries beyond what was already undone recently.
1836 Call `undo-start' to get ready to undo recent changes,
1837 then call `undo-more' one or more times to undo them."
1842 ;; Note: The following, while pulling elements off
1843 ;; `pending-undo-list' will call primitive change functions which
1844 ;; will push more elements onto `buffer-undo-list'.
1849 ;; Deep copy of a list
1851 "Make a copy of undo list LIST."
1857 elt))
1860 "Set `pending-undo-list' to the front of the undo list.
1861 The next call to `undo-more' will undo the most recently made change.
1862 If BEG and END are specified, then only undo elements
1863 that apply to text between BEG and END are used; other undo elements
1864 are ignored. If BEG and END are nil, all undo elements are used."
1870 buffer-undo-list)))
1875 "Return a list of undo elements for the region START to END.
1876 The elements come from `buffer-undo-list', but we keep only
1877 the elements inside this region, and discard those outside this region.
1878 If we find an element that crosses an edge of this region,
1879 we stop and ignore all further elements."
1882 undo-adjusted-markers
1883 some-rejected
1884 undo-elt temp-undo-list delta)
1889 ;; This is a "was unmodified" element.
1890 ;; Keep it if we have kept everything thus far.
1897 ;; Don't put two nils together in the list
1911 ;; Loop down the earlier events adjusting their buffer
1912 ;; positions to reflect the fact that a change to the buffer
1913 ;; isn't being undone. We only need to process those element
1914 ;; types which undo-elt-in-region will return as being in
1915 ;; the region since only those types can ever get into the
1916 ;; output
1925 ;; (TEXT . POSITION)
1932 ;; (BEGIN . END)
1937 ;; (nil PROPERTY VALUE BEG . END)
1947 "Determine whether UNDO-ELT falls inside the region START ... END.
1948 If it crosses the edge, we return nil."
1953 t)
1955 nil)
1957 ;; (TEXT . POSITION)
1961 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1962 ;; See if MARKER is inside the region.
1973 ;; (nil PROPERTY VALUE BEG . END)
1978 ;; (BEGIN . END)
1983 "Test whether UNDO-ELT crosses one edge of that region START ... END.
1984 This assumes we have already decided that UNDO-ELT
1985 is not *inside* the region START...END."
1988 ;; (nil PROPERTY VALUE BEG . END)
1993 ;; (BEGIN . END)
1997 ;; Return the first affected buffer position and the delta for an undo element
1998 ;; delta is defined as the change in subsequent buffer positions if we *did*
1999 ;; the undo.
2003 ;; (TEXT . POSITION)
2006 ;; (BEGIN . END)
2013 "If non-nil ask about discarding undo info for the current command.
2014 Normally, Emacs discards the undo info for the current command if
2015 it exceeds `undo-outer-limit'. But if you set this option
2016 non-nil, it asks in the echo area whether to discard the info.
2017 If you answer no, there is a slight risk that Emacs might crash, so
2018 only do it if you really want to undo the command.
2020 This option is mainly intended for debugging. You have to be
2021 careful if you use it for other purposes. Garbage collection is
2022 inhibited while the question is asked, meaning that Emacs might
2023 leak memory. So you should make sure that you do not wait
2024 excessively long before answering the question."
2030 "If non-nil, an extra level of size that's ok in an undo item.
2031 We don't ask the user about truncating the undo list until the
2032 current item gets bigger than this amount.
2037 ;; When the first undo batch in an undo list is longer than
2038 ;; undo-outer-limit, this function gets called to warn the user that
2039 ;; the undo info for the current command was discarded. Garbage
2040 ;; collection is inhibited around the call, so it had better not do a
2041 ;; lot of consing.
2047 ;; Don't ask the question again unless it gets even bigger.
2048 ;; This applies, in particular, if the user quits from the question.
2049 ;; Such a quit quits out of GC, but something else will call GC
2050 ;; again momentarily. It will call this function again,
2051 ;; but we don't want to ask the question again.
2058 t)
2059 nil))
2064 "The undo info was discarded because it exceeded \
2065 `undo-outer-limit'.
2067 This is normal if you executed a command that made a huge change
2068 to the buffer. In that case, to prevent similar problems in the
2069 future, set `undo-outer-limit' to a value that is large enough to
2070 cover the maximum size of normal changes you expect a single
2071 command to make, but not so large that it might exceed the
2072 maximum memory allotted to Emacs.
2074 If you did not execute any such command, the situation is
2075 probably due to a bug and you should report it.
2077 You can disable the popping up of this buffer by adding the entry
2078 \(undo discard-info) to the user option `warning-suppress-types',
2082 t))
2083 \f
2085 "History list for some commands that read shell commands.
2087 Maximum length of the history list is determined by the value
2094 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
2095 This buffer is used when `shell-command' or `shell-command-on-region'
2096 is run interactively. A value of nil means that output to stderr and
2103 "Return a list of all commands associated with the current file.
2104 This function is used to add all related commands retrieved by `mailcap'
2105 to the end of the list of defaults just after the default value."
2109 minibuffer-default))
2114 commands))
2125 map)
2129 "Read a shell command from the minibuffer.
2130 The arguments are the same as the ones of `read-from-minibuffer',
2131 except READ and KEYMAP are missing and HIST defaults
2132 to `shell-command-history'."
2140 minibuffer-local-shell-command-map
2141 nil
2143 args)))
2146 "Execute string COMMAND asynchronously in background.
2148 Like `shell-command' but if COMMAND doesn't end in ampersand, adds `&'
2149 surrounded by whitespace and executes the command asynchronously.
2150 The output appears in the buffer `*Async Shell Command*'.
2152 In Elisp, you will often be better served by calling `start-process'
2153 directly, since it offers more control and does not impose the use of a
2154 shell (with its need to quote arguments)."
2160 current-prefix-arg
2161 shell-command-default-error-buffer))
2167 "Execute string COMMAND in inferior shell; display output, if any.
2168 With prefix argument, insert the COMMAND's output at point.
2170 If COMMAND ends in ampersand, execute it asynchronously.
2171 The output appears in the buffer `*Async Shell Command*'.
2172 That buffer is in shell mode.
2174 Otherwise, COMMAND is executed synchronously. The output appears in
2175 the buffer `*Shell Command Output*'. If the output is short enough to
2176 display in the echo area (which is determined by the variables
2177 `resize-mini-windows' and `max-mini-window-height'), it is shown
2178 there, but it is nonetheless available in buffer `*Shell Command
2179 Output*' even though that buffer is not automatically displayed.
2181 To specify a coding system for converting non-ASCII characters
2183 before this command.
2185 Noninteractive callers can specify coding systems by binding
2186 `coding-system-for-read' and `coding-system-for-write'.
2188 The optional second argument OUTPUT-BUFFER, if non-nil,
2189 says to put the output in some other buffer.
2190 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2191 If OUTPUT-BUFFER is not a buffer and not nil,
2192 insert output in current buffer. (This cannot be done asynchronously.)
2193 In either case, the buffer is first erased, and the output is
2194 inserted after point (leaving mark after it).
2196 If the command terminates without error, but generates output,
2198 the output can be displayed in the echo area or in its buffer.
2199 If the output is short enough to display in the echo area
2200 \(determined by the variable `max-mini-window-height' if
2201 `resize-mini-windows' is non-nil), it is shown there.
2202 Otherwise,the buffer containing the output is displayed.
2206 of the output.
2208 If there is no output, or if output is inserted in the current buffer,
2209 then `*Shell Command Output*' is deleted.
2211 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2212 or buffer name to which to direct the command's standard error output.
2213 If it is nil, error output is mingled with regular output.
2214 In an interactive call, the variable `shell-command-default-error-buffer'
2215 specifies the value of ERROR-BUFFER.
2217 In Elisp, you will often be better served by calling `call-process' or
2218 `start-process' directly, since it offers more control and does not impose
2219 the use of a shell (with its need to quote arguments)."
2230 current-prefix-arg
2231 shell-command-default-error-buffer))
2232 ;; Look for a handler in case default-directory is a remote file name.
2240 ;; Output goes in current buffer.
2246 temporary-file-directory)))
2247 nil)))
2250 ;; We do not use -f for csh; we will not support broken use of
2251 ;; .cshrcs. Even the BSD csh manual says to use
2252 ;; "if ($?prompt) exit" before things which are not useful
2253 ;; non-interactively. Besides, if someone wants their other
2254 ;; aliases for shell commands then they can still have them.
2258 t)
2259 nil shell-command-switch command)
2266 ;; Do no formatting while reading error file,
2267 ;; because that can run a shell command, and we
2268 ;; don't want that to cause an infinite recursion.
2270 ;; Put point after the inserted errors.
2274 ;; This is like exchange-point-and-mark, but doesn't
2275 ;; activate the mark. It is cleaner to avoid activation,
2276 ;; even though the command loop would deactivate the mark
2277 ;; because we inserted text.
2281 ;; Output goes in a separate buffer.
2282 ;; Preserve the match data in case called from a program.
2285 ;; Command ending with ampersand means asynchronous.
2289 proc)
2290 ;; Remove the ampersand.
2292 ;; If will kill a process, query first.
2300 ;; Setting buffer-read-only to nil doesn't suffice
2301 ;; if some text has a non-nil read-only property,
2302 ;; which comint sometimes adds for prompts.
2308 shell-command-switch command))
2312 ;; Use the comint filter for proper handling of carriage motion
2313 ;; (see `comint-inhibit-carriage-motion'),.
2315 ))
2316 ;; Otherwise, command is executed synchronously.
2318 output-buffer nil error-buffer)))))))
2322 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2323 MESSAGE may be either a string or a buffer.
2325 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2326 the maximum height of the echo area, as defined by `max-mini-window-height'
2327 if `resize-mini-windows' is non-nil.
2329 Returns either the string shown in the echo area, or when a pop-up
2330 buffer is used, the window used to display it.
2332 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2333 name of the buffer used to display it in the case where a pop-up buffer
2334 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2335 string and it is displayed in the echo area, it is not specified whether
2336 the contents are inserted into the buffer anyway.
2338 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2339 and only used if a buffer is displayed."
2341 ;; Trivial case where we can use the echo area
2345 ;; Trivial case where we can just remove single trailing newline
2348 ;; General case
2351 message
2360 0
2364 (<= lines
2368 max-mini-window-height))
2370 max-mini-window-height)
2374 ;; Don't use the echo area if the output buffer is
2375 ;; already dispayed in the selected frame.
2377 ;; Echo area
2383 ;; Buffer
2386 not-this-window frame))))))))
2389 ;; We have a sentinel to prevent insertion of a termination message
2390 ;; in the buffer itself.
2398 &optional output-buffer replace
2399 error-buffer display-error-buffer)
2400 "Execute string COMMAND in inferior shell with region as input.
2401 Normally display output (if any) in temp buffer `*Shell Command Output*';
2402 Prefix arg means replace the region with it. Return the exit code of
2403 COMMAND.
2405 To specify a coding system for converting non-ASCII characters
2407 before this command. By default, the input (from the current buffer)
2408 is encoded in the same coding system that will be used to save the file,
2409 `buffer-file-coding-system'. If the output is going to replace the region,
2410 then it is decoded from that same coding system.
2412 The noninteractive arguments are START, END, COMMAND,
2413 OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
2414 Noninteractive callers can specify coding systems by binding
2415 `coding-system-for-read' and `coding-system-for-write'.
2417 If the command generates output, the output may be displayed
2418 in the echo area or in a buffer.
2419 If the output is short enough to display in the echo area
2420 \(determined by the variable `max-mini-window-height' if
2421 `resize-mini-windows' is non-nil), it is shown there. Otherwise
2422 it is displayed in the buffer `*Shell Command Output*'. The output
2423 is available in that buffer in both cases.
2425 If there is output and an error, a message about the error
2426 appears at the end of the output.
2428 If there is no output, or if output is inserted in the current buffer,
2429 then `*Shell Command Output*' is deleted.
2431 If the optional fourth argument OUTPUT-BUFFER is non-nil,
2432 that says to put the output in some other buffer.
2433 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2434 If OUTPUT-BUFFER is not a buffer and not nil,
2435 insert output in the current buffer.
2436 In either case, the output is inserted after point (leaving mark after it).
2438 If REPLACE, the optional fifth argument, is non-nil, that means insert
2439 the output in place of text from START to END, putting point and mark
2440 around it.
2442 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
2443 or buffer name to which to direct the command's standard error output.
2444 If it is nil, error output is mingled with regular output.
2445 If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
2446 were any errors. (This is always t, interactively.)
2447 In an interactive call, the variable `shell-command-default-error-buffer'
2448 specifies the value of ERROR-BUFFER."
2452 ;; Do this before calling region-beginning
2453 ;; and region-end, in case subprocess output
2454 ;; relocates them while we are in the minibuffer.
2456 ;; call-interactively recognizes region-beginning and
2457 ;; region-end specially, leaving them in the history.
2459 string
2460 current-prefix-arg
2461 current-prefix-arg
2462 shell-command-default-error-buffer
2463 t)))
2469 temporary-file-directory)))
2470 nil))
2471 exit-status)
2475 ;; Replace specified region with output from command.
2477 ;; Don't muck with mark unless REPLACE says we should.
2484 t)
2485 nil shell-command-switch command))
2486 ;; It is rude to delete a buffer which the command is not using.
2487 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2488 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2489 ;; (kill-buffer shell-buffer)))
2490 ;; Don't muck with mark unless REPLACE says we should.
2492 ;; No prefix argument: put the output in a temp buffer,
2493 ;; replacing its entire contents.
2498 ;; If the input is the same buffer as the output,
2499 ;; delete everything but the specified region,
2500 ;; then replace that region with the output.
2506 shell-file-name t
2509 t)
2510 nil shell-command-switch
2511 command)))
2512 ;; Clear the output buffer, then run the command with
2513 ;; output there.
2524 buffer)
2525 nil shell-command-switch command)))
2526 ;; Report the output.
2536 ;; There's some output, display it
2538 ;; No output; error?
2545 shell-command-default-error-buffer)
2552 output))
2555 exit-status))
2558 exit-status output))))
2559 ;; Don't kill: there might be useful info in the undo-log.
2560 ;; (kill-buffer buffer)
2561 ))))
2569 ;; Do no formatting while reading error file,
2570 ;; because that can run a shell command, and we
2571 ;; don't want that to cause an infinite recursion.
2573 ;; Put point after the inserted errors.
2578 exit-status))
2581 "Execute shell command COMMAND and return its output as a string."
2584 standard-output
2588 "Process files synchronously in a separate process.
2589 Similar to `call-process', but may invoke a file handler based on
2590 `default-directory'. The current working directory of the
2591 subprocess is `default-directory'.
2593 File names in INFILE and BUFFER are handled normally, but file
2594 names in ARGS should be relative to `default-directory', as they
2595 are passed to the process verbatim. \(This is a difference to
2596 `call-process' which does not support file handlers for INFILE
2597 and BUFFER.\)
2599 Some file handlers might not support all variants, for example
2600 they might behave as if DISPLAY was nil, regardless of the actual
2601 value passed."
2603 lc stderr-file)
2613 display args)
2619 "Whether a call of `process-file' changes remote files.
2621 Per default, this variable is always set to `t', meaning that a
2622 call of `process-file' could potentially change any file on a
2623 remote host. When set to `nil', a file handler could optimize
2624 its behaviour with respect to remote file attributes caching.
2626 This variable should never be changed by `setq'. Instead of, it
2630 "Start a program in a subprocess. Return the process object for it.
2632 Similar to `start-process', but may invoke a file handler based on
2633 `default-directory'. See Info node `(elisp)Magic File Names'.
2635 This handler ought to run PROGRAM, perhaps on the local host,
2636 perhaps on a remote host that corresponds to `default-directory'.
2637 In the latter case, the local part of `default-directory' becomes
2638 the working directory of the process.
2640 PROGRAM and PROGRAM-ARGS might be file names. They are not
2641 objects of file handler invocation. File handlers might not
2642 support pty association, if PROGRAM is nil."
2646 \f
2647 ;;;; Process menu
2659 "Major mode for listing the processes called by Emacs."
2671 "Recompute the list of processes for the Process List buffer."
2682 face link
2685 follow-link t
2686 process-buffer ,buf
2687 action process-menu-visit-buffer)
2696 "datagram"
2711 tabulated-list-entries)))))
2717 "Display a list of all processes.
2718 If optional argument QUERY-ONLY is non-nil, only processes with
2719 the query-on-exit flag set are listed.
2720 Any process listed as exited or signaled is actually eliminated
2721 after the listing is made.
2722 Optional argument BUFFER specifies a buffer to use, instead of
2724 The return value is always nil."
2736 nil)
2737 \f
2741 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
2742 (define-key map [switch-frame] nil)
2743 (define-key map [?\C-u] 'universal-argument-more)
2744 (define-key map [?-] 'universal-argument-minus)
2745 (define-key map [?0] 'digit-argument)
2746 (define-key map [?1] 'digit-argument)
2747 (define-key map [?2] 'digit-argument)
2748 (define-key map [?3] 'digit-argument)
2749 (define-key map [?4] 'digit-argument)
2750 (define-key map [?5] 'digit-argument)
2751 (define-key map [?6] 'digit-argument)
2752 (define-key map [?7] 'digit-argument)
2753 (define-key map [?8] 'digit-argument)
2754 (define-key map [?9] 'digit-argument)
2755 (define-key map [kp-0] 'digit-argument)
2756 (define-key map [kp-1] 'digit-argument)
2757 (define-key map [kp-2] 'digit-argument)
2758 (define-key map [kp-3] 'digit-argument)
2759 (define-key map [kp-4] 'digit-argument)
2760 (define-key map [kp-5] 'digit-argument)
2761 (define-key map [kp-6] 'digit-argument)
2762 (define-key map [kp-7] 'digit-argument)
2763 (define-key map [kp-8] 'digit-argument)
2764 (define-key map [kp-9] 'digit-argument)
2765 (define-key map [kp-subtract] 'universal-argument-minus)
2766 map)
2769 (defvar universal-argument-num-events nil
2770 "Number of argument-specifying events read by `universal-argument'.
2771 `universal-argument-other-key' uses this to discard those events
2772 from (this-command-keys), and reread only the final command.")
2774 (defvar saved-overriding-map t
2775 "The saved value of `overriding-terminal-local-map'.
2779 (defun save&set-overriding-map (map)
2780 "Set `overriding-terminal-local-map' to MAP."
2781 (when (eq saved-overriding-map t)
2782 (setq saved-overriding-map overriding-terminal-local-map)
2783 (setq overriding-terminal-local-map map)))
2785 (defun restore-overriding-map ()
2786 "Restore `overriding-terminal-local-map' to its saved value."
2787 (setq overriding-terminal-local-map saved-overriding-map)
2788 (setq saved-overriding-map t))
2790 (defun universal-argument ()
2791 "Begin a numeric argument for the following command.
2796 multiplies the argument by 4 each time.
2798 which is different in effect from any particular numeric argument.
2800 (interactive)
2801 (setq prefix-arg (list 4))
2802 (setq universal-argument-num-events (length (this-command-keys)))
2803 (save&set-overriding-map universal-argument-map))
2805 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
2806 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2807 (defun universal-argument-more (arg)
2808 (interactive "P")
2809 (if (consp arg)
2810 (setq prefix-arg (list (* 4 (car arg))))
2811 (if (eq arg '-)
2812 (setq prefix-arg (list -4))
2813 (setq prefix-arg arg)
2814 (restore-overriding-map)))
2815 (setq universal-argument-num-events (length (this-command-keys))))
2817 (defun negative-argument (arg)
2818 "Begin a negative numeric argument for the next command.
2820 (interactive "P")
2821 (cond ((integerp arg)
2822 (setq prefix-arg (- arg)))
2823 ((eq arg '-)
2824 (setq prefix-arg nil))
2825 (t
2826 (setq prefix-arg '-)))
2827 (setq universal-argument-num-events (length (this-command-keys)))
2828 (save&set-overriding-map universal-argument-map))
2830 (defun digit-argument (arg)
2831 "Part of the numeric argument for the next command.
2833 (interactive "P")
2834 (let* ((char (if (integerp last-command-event)
2835 last-command-event
2836 (get last-command-event 'ascii-character)))
2838 (cond ((integerp arg)
2839 (setq prefix-arg (+ (* arg 10)
2840 (if (< arg 0) (- digit) digit))))
2841 ((eq arg '-)
2842 ;; Treat -0 as just -, so that -01 will work.
2843 (setq prefix-arg (if (zerop digit) '- (- digit))))
2844 (t
2845 (setq prefix-arg digit))))
2846 (setq universal-argument-num-events (length (this-command-keys)))
2847 (save&set-overriding-map universal-argument-map))
2849 ;; For backward compatibility, minus with no modifiers is an ordinary
2850 ;; command if digits have already been entered.
2851 (defun universal-argument-minus (arg)
2852 (interactive "P")
2853 (if (integerp arg)
2854 (universal-argument-other-key arg)
2855 (negative-argument arg)))
2857 ;; Anything else terminates the argument and is left in the queue to be
2858 ;; executed as a command.
2859 (defun universal-argument-other-key (arg)
2860 (interactive "P")
2861 (setq prefix-arg arg)
2862 (let* ((key (this-command-keys))
2863 (keylist (listify-key-sequence key)))
2864 (setq unread-command-events
2865 (append (nthcdr universal-argument-num-events keylist)
2866 unread-command-events)))
2867 (reset-this-command-lengths)
2868 (restore-overriding-map))
2869 \f
2871 (defvar filter-buffer-substring-functions nil
2872 "Wrapper hook around `filter-buffer-substring'.
2873 The functions on this special hook are called with 4 arguments:
2874 NEXT-FUN BEG END DELETE
2875 NEXT-FUN is a function of 3 arguments (BEG END DELETE)
2876 that performs the default operation. The other 3 arguments are like
2877 the ones passed to `filter-buffer-substring'.")
2879 (defvar buffer-substring-filters nil
2880 "List of filter functions for `filter-buffer-substring'.
2881 Each function must accept a single argument, a string, and return
2882 a string. The buffer substring is passed to the first function
2883 in the list, and the return value of each function is passed to
2884 the next. The return value of the last function is used as the
2885 return value of `filter-buffer-substring'.
2887 If this variable is nil, no filtering is performed.")
2888 (make-obsolete-variable 'buffer-substring-filters
2889 'filter-buffer-substring-functions "24.1")
2891 (defun filter-buffer-substring (beg end &optional delete)
2892 "Return the buffer substring between BEG and END, after filtering.
2893 The filtering is performed by `filter-buffer-substring-functions'.
2895 If DELETE is non-nil, the text between BEG and END is deleted
2896 from the buffer.
2898 This function should be used instead of `buffer-substring',
2899 `buffer-substring-no-properties', or `delete-and-extract-region'
2900 when you want to allow filtering to take place. For example,
2901 major or minor modes can use `filter-buffer-substring-functions' to
2902 extract characters that are special to a buffer, and should not
2903 be copied into other buffers."
2904 (with-wrapper-hook filter-buffer-substring-functions (beg end delete)
2905 (cond
2906 ((or delete buffer-substring-filters)
2907 (save-excursion
2908 (goto-char beg)
2909 (let ((string (if delete (delete-and-extract-region beg end)
2910 (buffer-substring beg end))))
2911 (dolist (filter buffer-substring-filters)
2912 (setq string (funcall filter string)))
2913 string)))
2914 (t
2915 (buffer-substring beg end)))))
2918 ;;;; Window system cut and paste hooks.
2920 (defvar interprogram-cut-function nil
2921 "Function to call to make a killed region available to other programs.
2923 Most window systems provide some sort of facility for cutting and
2924 pasting text between the windows of different programs.
2925 This variable holds a function that Emacs calls whenever text
2926 is put in the kill ring, to make the new kill available to other
2927 programs.
2929 The function takes one argument, TEXT, which is a string containing
2930 the text which should be made available.")
2932 (defvar interprogram-paste-function nil
2933 "Function to call to get text cut from other programs.
2935 Most window systems provide some sort of facility for cutting and
2936 pasting text between the windows of different programs.
2937 This variable holds a function that Emacs calls to obtain
2938 text that other programs have provided for pasting.
2940 The function should be called with no arguments. If the function
2941 returns nil, then no other program has provided such text, and the top
2942 of the Emacs kill ring should be used. If the function returns a
2943 string, then the caller of the function \(usually `current-kill')
2944 should put this string in the kill ring as the latest kill.
2946 This function may also return a list of strings if the window
2947 system supports multiple selections. The first string will be
2948 used as the pasted text, but the other will be placed in the
2949 kill ring for easy access via `yank-pop'.
2951 Note that the function should return a string only if a program other
2952 than Emacs has provided a string for pasting; if Emacs provided the
2953 most recent string, the function should return nil. If it is
2954 difficult to tell whether Emacs or some other program provided the
2955 current string, it is probably good enough to return nil if the string
2956 is equal (according to `string=') to the last text Emacs provided.")
2957 \f
2960 ;;;; The kill ring data structure.
2962 (defvar kill-ring nil
2963 "List of killed text sequences.
2964 Since the kill ring is supposed to interact nicely with cut-and-paste
2965 facilities offered by window systems, use of this variable should
2966 interact nicely with `interprogram-cut-function' and
2967 `interprogram-paste-function'. The functions `kill-new',
2968 `kill-append', and `current-kill' are supposed to implement this
2969 interaction; you may want to use them instead of manipulating the kill
2970 ring directly.")
2972 (defcustom kill-ring-max 60
2973 "Maximum length of kill ring before oldest elements are thrown away."
2974 :type 'integer
2975 :group 'killing)
2977 (defvar kill-ring-yank-pointer nil
2978 "The tail of the kill ring whose car is the last thing yanked.")
2980 (defcustom save-interprogram-paste-before-kill nil
2981 "Save clipboard strings into kill ring before replacing them.
2982 When one selects something in another program to paste it into Emacs,
2983 but kills something in Emacs before actually pasting it,
2984 this selection is gone unless this variable is non-nil,
2985 in which case the other program's selection is saved in the `kill-ring'
2987 :type 'boolean
2988 :group 'killing
2989 :version "23.2")
2991 (defcustom kill-do-not-save-duplicates nil
2992 "Do not add a new string to `kill-ring' when it is the same as the last one."
2993 :type 'boolean
2994 :group 'killing
2995 :version "23.2")
2997 (defun kill-new (string &optional replace yank-handler)
2998 "Make STRING the latest kill in the kill ring.
2999 Set `kill-ring-yank-pointer' to point to it.
3000 If `interprogram-cut-function' is non-nil, apply it to STRING.
3001 Optional second argument REPLACE non-nil means that STRING will replace
3002 the front of the kill ring, rather than being added to the list.
3004 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3005 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3006 STRING.
3008 When the yank handler has a non-nil PARAM element, the original STRING
3009 argument is not used by `insert-for-yank'. However, since Lisp code
3010 may access and use elements from the kill ring directly, the STRING
3012 (if (> (length string) 0)
3013 (if yank-handler
3014 (put-text-property 0 (length string)
3015 'yank-handler yank-handler string))
3016 (if yank-handler
3017 (signal 'args-out-of-range
3018 (list string "yank-handler specified for empty string"))))
3019 (unless (and kill-do-not-save-duplicates
3020 (equal string (car kill-ring)))
3021 (if (fboundp 'menu-bar-update-yank-menu)
3022 (menu-bar-update-yank-menu string (and replace (car kill-ring)))))
3023 (when save-interprogram-paste-before-kill
3024 (let ((interprogram-paste (and interprogram-paste-function
3025 (funcall interprogram-paste-function))))
3026 (when interprogram-paste
3027 (dolist (s (if (listp interprogram-paste)
3028 (nreverse interprogram-paste)
3029 (list interprogram-paste)))
3030 (unless (and kill-do-not-save-duplicates
3031 (equal s (car kill-ring)))
3032 (push s kill-ring))))))
3033 (unless (and kill-do-not-save-duplicates
3034 (equal string (car kill-ring)))
3035 (if (and replace kill-ring)
3036 (setcar kill-ring string)
3037 (push string kill-ring)
3038 (if (> (length kill-ring) kill-ring-max)
3039 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))))
3040 (setq kill-ring-yank-pointer kill-ring)
3041 (if interprogram-cut-function
3042 (funcall interprogram-cut-function string)))
3043 (set-advertised-calling-convention
3044 'kill-new '(string &optional replace) "23.3")
3046 (defun kill-append (string before-p &optional yank-handler)
3047 "Append STRING to the end of the latest kill in the kill ring.
3048 If BEFORE-P is non-nil, prepend STRING to the kill.
3049 If `interprogram-cut-function' is set, pass the resulting kill to it."
3050 (let* ((cur (car kill-ring)))
3051 (kill-new (if before-p (concat string cur) (concat cur string))
3052 (or (= (length cur) 0)
3053 (equal yank-handler (get-text-property 0 'yank-handler cur)))
3054 yank-handler)))
3055 (set-advertised-calling-convention 'kill-append '(string before-p) "23.3")
3057 (defcustom yank-pop-change-selection nil
3058 "If non-nil, rotating the kill ring changes the window system selection."
3059 :type 'boolean
3060 :group 'killing
3061 :version "23.1")
3063 (defun current-kill (n &optional do-not-move)
3064 "Rotate the yanking point by N places, and then return that kill.
3065 If N is zero and `interprogram-paste-function' is set to a
3066 function that returns a string or a list of strings, and if that
3067 function doesn't return nil, then that string (or list) is added
3068 to the front of the kill ring and the string (or first string in
3069 the list) is returned as the latest kill.
3071 If N is not zero, and if `yank-pop-change-selection' is
3072 non-nil, use `interprogram-cut-function' to transfer the
3073 kill at the new yank point into the window system selection.
3075 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3076 move the yanking point; just return the Nth kill forward."
3078 (let ((interprogram-paste (and (= n 0)
3079 interprogram-paste-function
3080 (funcall interprogram-paste-function))))
3081 (if interprogram-paste
3082 (progn
3083 ;; Disable the interprogram cut function when we add the new
3084 ;; text to the kill ring, so Emacs doesn't try to own the
3085 ;; selection, with identical text.
3086 (let ((interprogram-cut-function nil))
3087 (if (listp interprogram-paste)
3088 (mapc 'kill-new (nreverse interprogram-paste))
3089 (kill-new interprogram-paste)))
3090 (car kill-ring))
3091 (or kill-ring (error "Kill ring is empty"))
3092 (let ((ARGth-kill-element
3093 (nthcdr (mod (- n (length kill-ring-yank-pointer))
3094 (length kill-ring))
3095 kill-ring)))
3096 (unless do-not-move
3097 (setq kill-ring-yank-pointer ARGth-kill-element)
3098 (when (and yank-pop-change-selection
3099 (> n 0)
3100 interprogram-cut-function)
3101 (funcall interprogram-cut-function (car ARGth-kill-element))))
3102 (car ARGth-kill-element)))))
3106 ;;;; Commands for manipulating the kill ring.
3108 (defcustom kill-read-only-ok nil
3109 "Non-nil means don't signal an error for killing read-only text."
3110 :type 'boolean
3111 :group 'killing)
3113 (put 'text-read-only 'error-conditions
3114 '(text-read-only buffer-read-only error))
3115 (put 'text-read-only 'error-message (purecopy "Text is read-only"))
3117 (defun kill-region (beg end &optional yank-handler)
3119 This deletes the text from the buffer and saves it in the kill ring.
3123 If you want to append the killed region to the last killed text,
3126 If the buffer is read-only, Emacs will beep and refrain from deleting
3127 the text, but put the text in the kill ring anyway. This means that
3128 you can use the killing commands to copy text from a read-only buffer.
3130 Lisp programs should use this function for killing text.
3131 (To delete text, use `delete-region'.)
3132 Supply two arguments, character positions indicating the stretch of text
3133 to be killed.
3135 If the previous command was also a kill command,
3136 the text killed this time appends to the text killed last time
3137 to make one entry in the kill ring."
3138 ;; Pass point first, then mark, because the order matters
3139 ;; when calling kill-append.
3140 (interactive (list (point) (mark)))
3141 (unless (and beg end)
3142 (error "The mark is not set now, so there is no region"))
3143 (condition-case nil
3144 (let ((string (filter-buffer-substring beg end t)))
3145 (when string ;STRING is nil if BEG = END
3146 ;; Add that string to the kill ring, one way or another.
3147 (if (eq last-command 'kill-region)
3148 (kill-append string (< end beg) yank-handler)
3149 (kill-new string nil yank-handler)))
3150 (when (or string (eq last-command 'kill-region))
3151 (setq this-command 'kill-region))
3152 nil)
3153 ((buffer-read-only text-read-only)
3154 ;; The code above failed because the buffer, or some of the characters
3155 ;; in the region, are read-only.
3156 ;; We should beep, in case the user just isn't aware of this.
3157 ;; However, there's no harm in putting
3158 ;; the region's text in the kill ring, anyway.
3159 (copy-region-as-kill beg end)
3160 ;; Set this-command now, so it will be set even if we get an error.
3161 (setq this-command 'kill-region)
3162 ;; This should barf, if appropriate, and give us the correct error.
3163 (if kill-read-only-ok
3164 (progn (message "Read only text copied to kill ring") nil)
3165 ;; Signal an error if the buffer is read-only.
3166 (barf-if-buffer-read-only)
3167 ;; If the buffer isn't read-only, the text is.
3168 (signal 'text-read-only (list (current-buffer)))))))
3169 (set-advertised-calling-convention 'kill-region '(beg end) "23.3")
3171 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3172 ;; to get two copies of the text when the user accidentally types M-w and
3173 ;; then corrects it with the intended C-w.
3174 (defun copy-region-as-kill (beg end)
3175 "Save the region as if killed, but don't kill it.
3176 In Transient Mark mode, deactivate the mark.
3177 If `interprogram-cut-function' is non-nil, also save the text for a window
3178 system cut and paste.
3180 This command's old key binding has been given to `kill-ring-save'."
3181 (interactive "r")
3182 (if (eq last-command 'kill-region)
3183 (kill-append (filter-buffer-substring beg end) (< end beg))
3184 (kill-new (filter-buffer-substring beg end)))
3185 (setq deactivate-mark t)
3186 nil)
3188 (defun kill-ring-save (beg end)
3189 "Save the region as if killed, but don't kill it.
3190 In Transient Mark mode, deactivate the mark.
3191 If `interprogram-cut-function' is non-nil, also save the text for a window
3192 system cut and paste.
3194 If you want to append the killed line to the last killed text,
3197 This command is similar to `copy-region-as-kill', except that it gives
3198 visual feedback indicating the extent of the region being copied."
3199 (interactive "r")
3200 (copy-region-as-kill beg end)
3201 ;; This use of called-interactively-p is correct
3202 ;; because the code it controls just gives the user visual feedback.
3203 (if (called-interactively-p 'interactive)
3204 (let ((other-end (if (= (point) beg) end beg))
3205 (opoint (point))
3206 ;; Inhibit quitting so we can make a quit here
3207 ;; look like a C-g typed as a command.
3208 (inhibit-quit t))
3209 (if (pos-visible-in-window-p other-end (selected-window))
3210 ;; Swap point-and-mark quickly so as to show the region that
3211 ;; was selected. Don't do it if the region is highlighted.
3212 (unless (and (region-active-p)
3213 (face-background 'region))
3214 ;; Swap point and mark.
3215 (set-marker (mark-marker) (point) (current-buffer))
3216 (goto-char other-end)
3217 (sit-for blink-matching-delay)
3218 ;; Swap back.
3219 (set-marker (mark-marker) other-end (current-buffer))
3220 (goto-char opoint)
3221 ;; If user quit, deactivate the mark
3222 ;; as C-g would as a command.
3223 (and quit-flag mark-active
3224 (deactivate-mark)))
3225 (let* ((killed-text (current-kill 0))
3226 (message-len (min (length killed-text) 40)))
3227 (if (= (point) beg)
3228 ;; Don't say "killed"; that is misleading.
3230 (substring killed-text (- message-len)))
3232 (substring killed-text 0 message-len))))))))
3234 (defun append-next-kill (&optional interactive)
3235 "Cause following command, if it kills, to append to previous kill.
3236 The argument is used for internal purposes; do not supply one."
3237 (interactive "p")
3238 ;; We don't use (interactive-p), since that breaks kbd macros.
3239 (if interactive
3240 (progn
3241 (setq this-command 'kill-region)
3242 (message "If the next command is a kill, it will append"))
3243 (setq last-command 'kill-region)))
3244 \f
3245 ;; Yanking.
3247 ;; This is actually used in subr.el but defcustom does not work there.
3248 (defcustom yank-excluded-properties
3249 '(read-only invisible intangible field mouse-face help-echo local-map keymap
3250 yank-handler follow-link fontified)
3251 "Text properties to discard when yanking.
3252 The value should be a list of text properties to discard or t,
3253 which means to discard all text properties."
3254 :type '(choice (const :tag "All" t) (repeat symbol))
3255 :group 'killing
3256 :version "22.1")
3258 (defvar yank-window-start nil)
3259 (defvar yank-undo-function nil
3260 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3261 Function is called with two parameters, START and END corresponding to
3262 the value of the mark and point; it is guaranteed that START <= END.
3263 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
3265 (defun yank-pop (&optional arg)
3266 "Replace just-yanked stretch of killed text with a different stretch.
3267 This command is allowed only immediately after a `yank' or a `yank-pop'.
3268 At such a time, the region contains a stretch of reinserted
3269 previously-killed text. `yank-pop' deletes that text and inserts in its
3270 place a different stretch of killed text.
3272 With no argument, the previous kill is inserted.
3273 With argument N, insert the Nth previous kill.
3274 If N is negative, this is a more recent kill.
3276 The sequence of kills wraps around, so that after the oldest one
3277 comes the newest one.
3279 When this command inserts killed text into the buffer, it honors
3280 `yank-excluded-properties' and `yank-handler' as described in the
3281 doc string for `insert-for-yank-1', which see."
3282 (interactive "*p")
3283 (if (not (eq last-command 'yank))
3284 (error "Previous command was not a yank"))
3285 (setq this-command 'yank)
3286 (unless arg (setq arg 1))
3287 (let ((inhibit-read-only t)
3288 (before (< (point) (mark t))))
3289 (if before
3290 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
3291 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
3292 (setq yank-undo-function nil)
3293 (set-marker (mark-marker) (point) (current-buffer))
3294 (insert-for-yank (current-kill arg))
3295 ;; Set the window start back where it was in the yank command,
3296 ;; if possible.
3297 (set-window-start (selected-window) yank-window-start t)
3298 (if before
3299 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3300 ;; It is cleaner to avoid activation, even though the command
3301 ;; loop would deactivate the mark because we inserted text.
3302 (goto-char (prog1 (mark t)
3303 (set-marker (mark-marker) (point) (current-buffer))))))
3304 nil)
3306 (defun yank (&optional arg)
3308 More precisely, reinsert the stretch of killed text most recently
3309 killed OR yanked. Put point at end, and set mark at beginning.
3310 With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
3311 With argument N, reinsert the Nth most recently killed stretch of killed
3312 text.
3314 When this command inserts killed text into the buffer, it honors
3315 `yank-excluded-properties' and `yank-handler' as described in the
3316 doc string for `insert-for-yank-1', which see.
3319 (interactive "*P")
3320 (setq yank-window-start (window-start))
3321 ;; If we don't get all the way thru, make last-command indicate that
3322 ;; for the following command.
3323 (setq this-command t)
3324 (push-mark (point))
3325 (insert-for-yank (current-kill (cond
3326 ((listp arg) 0)
3327 ((eq arg '-) -2)
3328 (t (1- arg)))))
3329 (if (consp arg)
3330 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3331 ;; It is cleaner to avoid activation, even though the command
3332 ;; loop would deactivate the mark because we inserted text.
3333 (goto-char (prog1 (mark t)
3334 (set-marker (mark-marker) (point) (current-buffer)))))
3335 ;; If we do get all the way thru, make this-command indicate that.
3336 (if (eq this-command t)
3337 (setq this-command 'yank))
3338 nil)
3340 (defun rotate-yank-pointer (arg)
3341 "Rotate the yanking point in the kill ring.
3342 With ARG, rotate that many kills forward (or backward, if negative)."
3343 (interactive "p")
3344 (current-kill arg))
3345 \f
3346 ;; Some kill commands.
3348 ;; Internal subroutine of delete-char
3349 (defun kill-forward-chars (arg)
3350 (if (listp arg) (setq arg (car arg)))
3351 (if (eq arg '-) (setq arg -1))
3352 (kill-region (point) (+ (point) arg)))
3354 ;; Internal subroutine of backward-delete-char
3355 (defun kill-backward-chars (arg)
3356 (if (listp arg) (setq arg (car arg)))
3357 (if (eq arg '-) (setq arg -1))
3358 (kill-region (point) (- (point) arg)))
3360 (defcustom backward-delete-char-untabify-method 'untabify
3361 "The method for untabifying when deleting backward.
3362 Can be `untabify' -- turn a tab to many spaces, then delete one space;
3363 `hungry' -- delete all whitespace, both tabs and spaces;
3364 `all' -- delete all whitespace, including tabs, spaces and newlines;
3365 nil -- just delete one character."
3366 :type '(choice (const untabify) (const hungry) (const all) (const nil))
3367 :version "20.3"
3368 :group 'killing)
3370 (defun backward-delete-char-untabify (arg &optional killp)
3371 "Delete characters backward, changing tabs into spaces.
3372 The exact behavior depends on `backward-delete-char-untabify-method'.
3373 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
3374 Interactively, ARG is the prefix arg (default 1)
3375 and KILLP is t if a prefix arg was specified."
3377 (when (eq backward-delete-char-untabify-method 'untabify)
3378 (let ((count arg))
3379 (save-excursion
3380 (while (and (> count 0) (not (bobp)))
3382 (let ((col (current-column)))
3383 (forward-char -1)
3384 (setq col (- col (current-column)))
3385 (insert-char ?\s col)
3386 (delete-char 1)))
3387 (forward-char -1)
3388 (setq count (1- count))))))
3390 ((eq backward-delete-char-untabify-method 'all)
3392 (n (if skip
3393 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
3394 (point)))))
3395 (+ arg (if (zerop wh) 0 (1- wh))))
3396 arg)))
3397 ;; Avoid warning about delete-backward-char
3398 (with-no-warnings (delete-backward-char n killp))))
3400 (defun zap-to-char (arg char)
3401 "Kill up to and including ARGth occurrence of CHAR.
3402 Case is ignored if `case-fold-search' is non-nil in the current buffer.
3403 Goes backward if ARG is negative; error if CHAR not found."
3405 ;; Avoid "obsolete" warnings for translation-table-for-input.
3406 (with-no-warnings
3407 (if (char-table-p translation-table-for-input)
3408 (setq char (or (aref translation-table-for-input char) char))))
3409 (kill-region (point) (progn
3410 (search-forward (char-to-string char) nil nil arg)
3411 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
3412 (point))))
3414 ;; kill-line and its subroutines.
3416 (defcustom kill-whole-line nil
3417 "If non-nil, `kill-line' with no arg at beg of line kills the whole line."
3418 :type 'boolean
3419 :group 'killing)
3421 (defun kill-line (&optional arg)
3422 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
3423 With prefix argument ARG, kill that many lines from point.
3424 Negative arguments kill lines backward.
3425 With zero argument, kills the text before point on the current line.
3428 a number counts as a prefix arg.
3430 To kill a whole line, when point is not at the beginning, type \
3433 If `kill-whole-line' is non-nil, then this command kills the whole line
3434 including its terminating newline, when used at the beginning of a line
3435 with no argument. As a consequence, you can always kill a whole line
3438 If you want to append the killed line to the last killed text,
3441 If the buffer is read-only, Emacs will beep and refrain from deleting
3442 the line, but put the line in the kill ring anyway. This means that
3443 you can use this command to copy text from a read-only buffer.
3444 \(If the variable `kill-read-only-ok' is non-nil, then this won't
3445 even beep.)"
3446 (interactive "P")
3447 (kill-region (point)
3448 ;; It is better to move point to the other end of the kill
3449 ;; before killing. That way, in a read-only buffer, point
3450 ;; moves across the text that is copied to the kill ring.
3451 ;; The choice has no effect on undo now that undo records
3452 ;; the value of point from before the command was run.
3453 (progn
3454 (if arg
3455 (forward-visible-line (prefix-numeric-value arg))
3456 (if (eobp)
3457 (signal 'end-of-buffer nil))
3458 (let ((end
3459 (save-excursion
3460 (end-of-visible-line) (point))))
3461 (if (or (save-excursion
3462 ;; If trailing whitespace is visible,
3463 ;; don't treat it as nothing.
3464 (unless show-trailing-whitespace
3466 (= (point) end))
3467 (and kill-whole-line (bolp)))
3468 (forward-visible-line 1)
3469 (goto-char end))))
3470 (point))))
3472 (defun kill-whole-line (&optional arg)
3473 "Kill current line.
3474 With prefix ARG, kill that many lines starting from the current line.
3475 If ARG is negative, kill backward. Also kill the preceding newline.
3477 If ARG is zero, kill current line but exclude the trailing newline."
3478 (interactive "p")
3479 (or arg (setq arg 1))
3480 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
3481 (signal 'end-of-buffer nil))
3482 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
3483 (signal 'beginning-of-buffer nil))
3484 (unless (eq last-command 'kill-region)
3485 (kill-new "")
3486 (setq last-command 'kill-region))
3487 (cond ((zerop arg)
3488 ;; We need to kill in two steps, because the previous command
3489 ;; could have been a kill command, in which case the text
3490 ;; before point needs to be prepended to the current kill
3491 ;; ring entry and the text after point appended. Also, we
3492 ;; need to use save-excursion to avoid copying the same text
3493 ;; twice to the kill ring in read-only buffers.
3494 (save-excursion
3495 (kill-region (point) (progn (forward-visible-line 0) (point))))
3496 (kill-region (point) (progn (end-of-visible-line) (point))))
3497 ((< arg 0)
3498 (save-excursion
3499 (kill-region (point) (progn (end-of-visible-line) (point))))
3500 (kill-region (point)
3501 (progn (forward-visible-line (1+ arg))
3502 (unless (bobp) (backward-char))
3503 (point))))
3504 (t
3505 (save-excursion
3506 (kill-region (point) (progn (forward-visible-line 0) (point))))
3507 (kill-region (point)
3508 (progn (forward-visible-line arg) (point))))))
3510 (defun forward-visible-line (arg)
3511 "Move forward by ARG lines, ignoring currently invisible newlines only.
3512 If ARG is negative, move backward -ARG lines.
3513 If ARG is zero, move to the beginning of the current line."
3514 (condition-case nil
3515 (if (> arg 0)
3516 (progn
3517 (while (> arg 0)
3518 (or (zerop (forward-line 1))
3519 (signal 'end-of-buffer nil))
3520 ;; If the newline we just skipped is invisible,
3521 ;; don't count it.
3522 (let ((prop
3523 (get-char-property (1- (point)) 'invisible)))
3524 (if (if (eq buffer-invisibility-spec t)
3525 prop
3526 (or (memq prop buffer-invisibility-spec)
3527 (assq prop buffer-invisibility-spec)))
3528 (setq arg (1+ arg))))
3529 (setq arg (1- arg)))
3530 ;; If invisible text follows, and it is a number of complete lines,
3531 ;; skip it.
3532 (let ((opoint (point)))
3533 (while (and (not (eobp))
3534 (let ((prop
3535 (get-char-property (point) 'invisible)))
3536 (if (eq buffer-invisibility-spec t)
3537 prop
3538 (or (memq prop buffer-invisibility-spec)
3539 (assq prop buffer-invisibility-spec)))))
3540 (goto-char
3541 (if (get-text-property (point) 'invisible)
3542 (or (next-single-property-change (point) 'invisible)
3543 (point-max))
3544 (next-overlay-change (point)))))
3545 (unless (bolp)
3546 (goto-char opoint))))
3547 (let ((first t))
3548 (while (or first (<= arg 0))
3549 (if first
3550 (beginning-of-line)
3551 (or (zerop (forward-line -1))
3552 (signal 'beginning-of-buffer nil)))
3553 ;; If the newline we just moved to is invisible,
3554 ;; don't count it.
3555 (unless (bobp)
3556 (let ((prop
3557 (get-char-property (1- (point)) 'invisible)))
3558 (unless (if (eq buffer-invisibility-spec t)
3559 prop
3560 (or (memq prop buffer-invisibility-spec)
3561 (assq prop buffer-invisibility-spec)))
3562 (setq arg (1+ arg)))))
3563 (setq first nil))
3564 ;; If invisible text follows, and it is a number of complete lines,
3565 ;; skip it.
3566 (let ((opoint (point)))
3567 (while (and (not (bobp))
3568 (let ((prop
3569 (get-char-property (1- (point)) 'invisible)))
3570 (if (eq buffer-invisibility-spec t)
3571 prop
3572 (or (memq prop buffer-invisibility-spec)
3573 (assq prop buffer-invisibility-spec)))))
3574 (goto-char
3575 (if (get-text-property (1- (point)) 'invisible)
3576 (or (previous-single-property-change (point) 'invisible)
3577 (point-min))
3578 (previous-overlay-change (point)))))
3579 (unless (bolp)
3580 (goto-char opoint)))))
3581 ((beginning-of-buffer end-of-buffer)
3582 nil)))
3584 (defun end-of-visible-line ()
3585 "Move to end of current visible line."
3586 (end-of-line)
3587 ;; If the following character is currently invisible,
3588 ;; skip all characters with that same `invisible' property value,
3589 ;; then find the next newline.
3590 (while (and (not (eobp))
3591 (save-excursion
3593 (let ((prop
3594 (get-char-property (point) 'invisible)))
3595 (if (eq buffer-invisibility-spec t)
3596 prop
3597 (or (memq prop buffer-invisibility-spec)
3598 (assq prop buffer-invisibility-spec))))))
3600 (if (get-text-property (point) 'invisible)
3601 (goto-char (next-single-property-change (point) 'invisible))
3602 (goto-char (next-overlay-change (point))))
3603 (end-of-line)))
3604 \f
3605 (defun insert-buffer (buffer)
3606 "Insert after point the contents of BUFFER.
3607 Puts mark after the inserted text.
3608 BUFFER may be a buffer or a buffer name.
3610 This function is meant for the user to run interactively.
3611 Don't call it from programs: use `insert-buffer-substring' instead!"
3612 (interactive
3613 (list
3614 (progn
3615 (barf-if-buffer-read-only)
3616 (read-buffer "Insert buffer: "
3617 (if (eq (selected-window) (next-window (selected-window)))
3618 (other-buffer (current-buffer))
3619 (window-buffer (next-window (selected-window))))
3620 t))))
3621 (push-mark
3622 (save-excursion
3623 (insert-buffer-substring (get-buffer buffer))
3624 (point)))
3625 nil)
3627 (defun append-to-buffer (buffer start end)
3628 "Append to specified buffer the text of the region.
3629 It is inserted into that buffer before its point.
3631 When calling from a program, give three arguments:
3632 BUFFER (or buffer name), START and END.
3633 START and END specify the portion of the current buffer to be copied."
3634 (interactive
3635 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
3636 (region-beginning) (region-end)))
3637 (let* ((oldbuf (current-buffer))
3638 (append-to (get-buffer-create buffer))
3639 (windows (get-buffer-window-list append-to t t))
3640 point)
3641 (save-excursion
3642 (with-current-buffer append-to
3643 (setq point (point))
3644 (barf-if-buffer-read-only)
3645 (insert-buffer-substring oldbuf start end)
3646 (dolist (window windows)
3647 (when (= (window-point window) point)
3648 (set-window-point window (point))))))))
3650 (defun prepend-to-buffer (buffer start end)
3651 "Prepend to specified buffer the text of the region.
3652 It is inserted into that buffer after its point.
3654 When calling from a program, give three arguments:
3655 BUFFER (or buffer name), START and END.
3656 START and END specify the portion of the current buffer to be copied."
3658 (let ((oldbuf (current-buffer)))
3659 (with-current-buffer (get-buffer-create buffer)
3660 (barf-if-buffer-read-only)
3661 (save-excursion
3662 (insert-buffer-substring oldbuf start end)))))
3664 (defun copy-to-buffer (buffer start end)
3665 "Copy to specified buffer the text of the region.
3666 It is inserted into that buffer, replacing existing text there.
3668 When calling from a program, give three arguments:
3669 BUFFER (or buffer name), START and END.
3670 START and END specify the portion of the current buffer to be copied."
3672 (let ((oldbuf (current-buffer)))
3673 (with-current-buffer (get-buffer-create buffer)
3674 (barf-if-buffer-read-only)
3675 (erase-buffer)
3676 (save-excursion
3677 (insert-buffer-substring oldbuf start end)))))
3678 \f
3679 (put 'mark-inactive 'error-conditions '(mark-inactive error))
3680 (put 'mark-inactive 'error-message (purecopy "The mark is not active now"))
3682 (defvar activate-mark-hook nil
3683 "Hook run when the mark becomes active.
3684 It is also run at the end of a command, if the mark is active and
3685 it is possible that the region may have changed.")
3687 (defvar deactivate-mark-hook nil
3688 "Hook run when the mark becomes inactive.")
3690 (defun mark (&optional force)
3691 "Return this buffer's mark value as integer, or nil if never set.
3693 In Transient Mark mode, this function signals an error if
3694 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
3695 or the argument FORCE is non-nil, it disregards whether the mark
3696 is active, and returns an integer or nil in the usual way.
3698 If you are using this in an editing command, you are most likely making
3699 a mistake; see the documentation of `set-mark'."
3700 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
3701 (marker-position (mark-marker))
3702 (signal 'mark-inactive nil)))
3704 (defsubst deactivate-mark (&optional force)
3705 "Deactivate the mark by setting `mark-active' to nil.
3706 Unless FORCE is non-nil, this function does nothing if Transient
3707 Mark mode is disabled.
3708 This function also runs `deactivate-mark-hook'."
3709 (when (or transient-mark-mode force)
3710 (when (and (if (eq select-active-regions 'only)
3711 (eq (car-safe transient-mark-mode) 'only)
3712 select-active-regions)
3713 (region-active-p)
3714 (display-selections-p))
3715 ;; The var `saved-region-selection', if non-nil, is the text in
3716 ;; the region prior to the last command modifying the buffer.
3717 ;; Set the selection to that, or to the current region.
3718 (cond (saved-region-selection
3719 (x-set-selection 'PRIMARY saved-region-selection)
3720 (setq saved-region-selection nil))
3721 ((/= (region-beginning) (region-end))
3722 (x-set-selection 'PRIMARY
3723 (buffer-substring-no-properties
3724 (region-beginning)
3725 (region-end))))))
3726 (if (and (null force)
3727 (or (eq transient-mark-mode 'lambda)
3728 (and (eq (car-safe transient-mark-mode) 'only)
3729 (null (cdr transient-mark-mode)))))
3730 ;; When deactivating a temporary region, don't change
3731 ;; `mark-active' or run `deactivate-mark-hook'.
3732 (setq transient-mark-mode nil)
3733 (if (eq (car-safe transient-mark-mode) 'only)
3734 (setq transient-mark-mode (cdr transient-mark-mode)))
3735 (setq mark-active nil)
3736 (run-hooks 'deactivate-mark-hook))))
3738 (defun activate-mark ()
3739 "Activate the mark."
3740 (when (mark t)
3741 (setq mark-active t)
3742 (unless transient-mark-mode
3743 (setq transient-mark-mode 'lambda))))
3745 (defun set-mark (pos)
3746 "Set this buffer's mark to POS. Don't use this function!
3747 That is to say, don't use this function unless you want
3748 the user to see that the mark has moved, and you want the previous
3749 mark position to be lost.
3751 Normally, when a new mark is set, the old one should go on the stack.
3752 This is why most applications should use `push-mark', not `set-mark'.
3754 Novice Emacs Lisp programmers often try to use the mark for the wrong
3755 purposes. The mark saves a location for the user's convenience.
3756 Most editing commands should not alter the mark.
3757 To remember a location for internal use in the Lisp program,
3758 store it in a Lisp variable. Example:
3760 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
3762 (if pos
3763 (progn
3764 (setq mark-active t)
3765 (run-hooks 'activate-mark-hook)
3766 (set-marker (mark-marker) pos (current-buffer)))
3767 ;; Normally we never clear mark-active except in Transient Mark mode.
3768 ;; But when we actually clear out the mark value too, we must
3769 ;; clear mark-active in any mode.
3770 (deactivate-mark t)
3771 (set-marker (mark-marker) nil)))
3773 (defcustom use-empty-active-region nil
3775 If nil, region-aware commands treat empty regions as inactive.
3776 If non-nil, region-aware commands treat the region as active as
3777 long as the mark is active, even if the region is empty.
3779 Region-aware commands are those that act on the region if it is
3780 active and Transient Mark mode is enabled, and on the text near
3781 point otherwise."
3782 :type 'boolean
3783 :version "23.1"
3784 :group 'editing-basics)
3786 (defun use-region-p ()
3787 "Return t if the region is active and it is appropriate to act on it.
3788 This is used by commands that act specially on the region under
3789 Transient Mark mode.
3791 The return value is t if Transient Mark mode is enabled and the
3792 mark is active; furthermore, if `use-empty-active-region' is nil,
3793 the region must not be empty. Otherwise, the return value is nil.
3795 For some commands, it may be appropriate to ignore the value of
3796 `use-empty-active-region'; in that case, use `region-active-p'."
3797 (and (region-active-p)
3798 (or use-empty-active-region (> (region-end) (region-beginning)))))
3800 (defun region-active-p ()
3801 "Return t if Transient Mark mode is enabled and the mark is active.
3803 Some commands act specially on the region when Transient Mark
3804 mode is enabled. Usually, such commands should use
3805 `use-region-p' instead of this function, because `use-region-p'
3806 also checks the value of `use-empty-active-region'."
3807 (and transient-mark-mode mark-active))
3809 (defvar mark-ring nil
3810 "The list of former marks of the current buffer, most recent first.")
3811 (make-variable-buffer-local 'mark-ring)
3812 (put 'mark-ring 'permanent-local t)
3814 (defcustom mark-ring-max 16
3815 "Maximum size of mark ring. Start discarding off end if gets this big."
3816 :type 'integer
3817 :group 'editing-basics)
3819 (defvar global-mark-ring nil
3820 "The list of saved global marks, most recent first.")
3822 (defcustom global-mark-ring-max 16
3823 "Maximum size of global mark ring. \
3824 Start discarding off end if gets this big."
3825 :type 'integer
3826 :group 'editing-basics)
3828 (defun pop-to-mark-command ()
3829 "Jump to mark, and pop a new position for mark off the ring.
3830 \(Does not affect global mark ring\)."
3831 (interactive)
3832 (if (null (mark t))
3833 (error "No mark set in this buffer")
3834 (if (= (point) (mark t))
3835 (message "Mark popped"))
3836 (goto-char (mark t))
3837 (pop-mark)))
3839 (defun push-mark-command (arg &optional nomsg)
3840 "Set mark at where point is.
3841 If no prefix ARG and mark is already set there, just activate it.
3842 Display `Mark set' unless the optional second arg NOMSG is non-nil."
3843 (interactive "P")
3844 (let ((mark (marker-position (mark-marker))))
3845 (if (or arg (null mark) (/= mark (point)))
3846 (push-mark nil nomsg t)
3847 (setq mark-active t)
3848 (run-hooks 'activate-mark-hook)
3849 (unless nomsg
3850 (message "Mark activated")))))
3852 (defcustom set-mark-command-repeat-pop nil
3855 will pop the mark twice, and
3857 will pop the mark three times.
3861 :type 'boolean
3862 :group 'editing-basics)
3864 (defcustom set-mark-default-inactive nil
3865 "If non-nil, setting the mark does not activate it.
3867 behave the same whether or not `transient-mark-mode' is enabled."
3868 :type 'boolean
3869 :group 'editing-basics
3870 :version "23.1")
3872 (defun set-mark-command (arg)
3873 "Set the mark where point is, or jump to the mark.
3874 Setting the mark also alters the region, which is the text
3875 between point and mark; this is the closest equivalent in
3878 With no prefix argument, set the mark at point, and push the
3879 old mark position on local mark ring. Also push the old mark on
3880 global mark ring, if the previous mark was set in another buffer.
3882 When Transient Mark Mode is off, immediately repeating this
3883 command activates `transient-mark-mode' temporarily.
3886 jump to the mark, and set the mark from
3887 position popped off the local mark ring \(this does not affect the global
3889 mark ring \(see `pop-global-mark'\).
3891 If `set-mark-command-repeat-pop' is non-nil, repeating
3893 off the local (or global) mark ring and jumps there.
3896 argument, unconditionally set mark where point is, even if
3897 `set-mark-command-repeat-pop' is non-nil.
3899 Novice Emacs Lisp programmers often try to use the mark for the wrong
3900 purposes. See the documentation of `set-mark' for more information."
3901 (interactive "P")
3902 (cond ((eq transient-mark-mode 'lambda)
3903 (setq transient-mark-mode nil))
3904 ((eq (car-safe transient-mark-mode) 'only)
3905 (deactivate-mark)))
3906 (cond
3907 ((and (consp arg) (> (prefix-numeric-value arg) 4))
3908 (push-mark-command nil))
3909 ((not (eq this-command 'set-mark-command))
3910 (if arg
3911 (pop-to-mark-command)
3912 (push-mark-command t)))
3913 ((and set-mark-command-repeat-pop
3914 (eq last-command 'pop-to-mark-command))
3915 (setq this-command 'pop-to-mark-command)
3916 (pop-to-mark-command))
3917 ((and set-mark-command-repeat-pop
3918 (eq last-command 'pop-global-mark)
3919 (not arg))
3920 (setq this-command 'pop-global-mark)
3921 (pop-global-mark))
3922 (arg
3923 (setq this-command 'pop-to-mark-command)
3924 (pop-to-mark-command))
3925 ((eq last-command 'set-mark-command)
3926 (if (region-active-p)
3927 (progn
3928 (deactivate-mark)
3929 (message "Mark deactivated"))
3930 (activate-mark)
3931 (message "Mark activated")))
3932 (t
3933 (push-mark-command nil)
3934 (if set-mark-default-inactive (deactivate-mark)))))
3936 (defun push-mark (&optional location nomsg activate)
3937 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
3938 If the last global mark pushed was not in the current buffer,
3939 also push LOCATION on the global mark ring.
3940 Display `Mark set' unless the optional second arg NOMSG is non-nil.
3942 Novice Emacs Lisp programmers often try to use the mark for the wrong
3943 purposes. See the documentation of `set-mark' for more information.
3945 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
3946 (unless (null (mark t))
3947 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
3948 (when (> (length mark-ring) mark-ring-max)
3949 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
3950 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
3951 (set-marker (mark-marker) (or location (point)) (current-buffer))
3952 ;; Now push the mark on the global mark ring.
3953 (if (and global-mark-ring
3954 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
3955 ;; The last global mark pushed was in this same buffer.
3956 ;; Don't push another one.
3957 nil
3958 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
3959 (when (> (length global-mark-ring) global-mark-ring-max)
3960 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
3961 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
3962 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
3963 (message "Mark set"))
3964 (if (or activate (not transient-mark-mode))
3965 (set-mark (mark t)))
3966 nil)
3968 (defun pop-mark ()
3969 "Pop off mark ring into the buffer's actual mark.
3970 Does not set point. Does nothing if mark ring is empty."
3971 (when mark-ring
3972 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
3973 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
3974 (move-marker (car mark-ring) nil)
3975 (if (null (mark t)) (ding))
3976 (setq mark-ring (cdr mark-ring)))
3977 (deactivate-mark))
3979 (define-obsolete-function-alias
3980 'exchange-dot-and-mark 'exchange-point-and-mark "23.3")
3981 (defun exchange-point-and-mark (&optional arg)
3982 "Put the mark where point is now, and point where the mark is now.
3983 This command works even when the mark is not active,
3984 and it reactivates the mark.
3986 If Transient Mark mode is on, a prefix ARG deactivates the mark
3987 if it is active, and otherwise avoids reactivating it. If
3988 Transient Mark mode is off, a prefix ARG enables Transient Mark
3989 mode temporarily."
3990 (interactive "P")
3991 (let ((omark (mark t))
3992 (temp-highlight (eq (car-safe transient-mark-mode) 'only)))
3993 (if (null omark)
3994 (error "No mark set in this buffer"))
3995 (deactivate-mark)
3996 (set-mark (point))
3997 (goto-char omark)
3998 (if set-mark-default-inactive (deactivate-mark))
3999 (cond (temp-highlight
4000 (setq transient-mark-mode (cons 'only transient-mark-mode)))
4001 ((or (and arg (region-active-p)) ; (xor arg (not (region-active-p)))
4002 (not (or arg (region-active-p))))
4003 (deactivate-mark))
4004 (t (activate-mark)))
4005 nil))
4007 (defcustom shift-select-mode t
4008 "When non-nil, shifted motion keys activate the mark momentarily.
4010 While the mark is activated in this way, any shift-translated point
4011 motion key extends the region, and if Transient Mark mode was off, it
4012 is temporarily turned on. Furthermore, the mark will be deactivated
4013 by any subsequent point motion key that was not shift-translated, or
4014 by any action that normally deactivates the mark in Transient Mark mode.
4016 See `this-command-keys-shift-translated' for the meaning of
4017 shift-translation."
4018 :type 'boolean
4019 :group 'editing-basics)
4021 (defun handle-shift-selection ()
4022 "Activate/deactivate mark depending on invocation thru shift translation.
4023 This function is called by `call-interactively' when a command
4024 with a `^' character in its `interactive' spec is invoked, before
4025 running the command itself.
4027 If `shift-select-mode' is enabled and the command was invoked
4028 through shift translation, set the mark and activate the region
4029 temporarily, unless it was already set in this way. See
4030 `this-command-keys-shift-translated' for the meaning of shift
4031 translation.
4033 Otherwise, if the region has been activated temporarily,
4034 deactivate it, and restore the variable `transient-mark-mode' to
4035 its earlier value."
4036 (cond ((and shift-select-mode this-command-keys-shift-translated)
4037 (unless (and mark-active
4038 (eq (car-safe transient-mark-mode) 'only))
4039 (setq transient-mark-mode
4040 (cons 'only
4041 (unless (eq transient-mark-mode 'lambda)
4042 transient-mark-mode)))
4043 (push-mark nil nil t)))
4044 ((eq (car-safe transient-mark-mode) 'only)
4045 (setq transient-mark-mode (cdr transient-mark-mode))
4046 (deactivate-mark))))
4048 (define-minor-mode transient-mark-mode
4049 "Toggle Transient Mark mode.
4050 With ARG, turn Transient Mark mode on if ARG is positive, off otherwise.
4052 In Transient Mark mode, when the mark is active, the region is highlighted.
4054 So do certain other operations that set the mark
4055 but whose main purpose is something else--for example,
4061 Many commands change their behavior when Transient Mark mode is in effect
4062 and the mark is active, by acting on the region instead of their usual
4063 default part of the buffer's text. Examples of such commands include
4068 commands which are sensitive to the Transient Mark mode."
4069 :global t
4070 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4071 :variable transient-mark-mode)
4073 (defvar widen-automatically t
4074 "Non-nil means it is ok for commands to call `widen' when they want to.
4075 Some commands will do this in order to go to positions outside
4076 the current accessible part of the buffer.
4078 If `widen-automatically' is nil, these commands will do something else
4079 as a fallback, and won't change the buffer bounds.")
4081 (defvar non-essential nil
4082 "Whether the currently executing code is performing an essential task.
4083 This variable should be non-nil only when running code which should not
4084 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4085 user for a password when we are simply scanning a set of files in the
4086 background or displaying possible completions before the user even asked
4087 for it.")
4089 (defun pop-global-mark ()
4090 "Pop off global mark ring and jump to the top location."
4091 (interactive)
4092 ;; Pop entries which refer to non-existent buffers.
4093 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
4094 (setq global-mark-ring (cdr global-mark-ring)))
4095 (or global-mark-ring
4096 (error "No global mark set"))
4097 (let* ((marker (car global-mark-ring))
4098 (buffer (marker-buffer marker))
4099 (position (marker-position marker)))
4100 (setq global-mark-ring (nconc (cdr global-mark-ring)
4101 (list (car global-mark-ring))))
4102 (set-buffer buffer)
4103 (or (and (>= position (point-min))
4104 (<= position (point-max)))
4105 (if widen-automatically
4106 (widen)
4107 (error "Global mark position is outside accessible part of buffer")))
4108 (goto-char position)
4109 (switch-to-buffer buffer)))
4110 \f
4111 (defcustom next-line-add-newlines nil
4112 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4113 :type 'boolean
4114 :version "21.1"
4115 :group 'editing-basics)
4117 (defun next-line (&optional arg try-vscroll)
4118 "Move cursor vertically down ARG lines.
4119 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4120 If there is no character in the target line exactly under the current column,
4121 the cursor is positioned after the character in that line which spans this
4122 column, or at the end of the line if it is not long enough.
4123 If there is no line in the buffer after this one, behavior depends on the
4124 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4125 to create a line, and moves the cursor to that line. Otherwise it moves the
4126 cursor to the end of the buffer.
4128 If the variable `line-move-visual' is non-nil, this command moves
4129 by display lines. Otherwise, it moves by buffer lines, without
4130 taking variable-width characters or continued lines into account.
4133 a semipermanent goal column for this command.
4134 Then instead of trying to move exactly vertically (or as close as possible),
4135 this command moves to the specified goal column (or as close as possible).
4136 The goal column is stored in the variable `goal-column', which is nil
4137 when there is no goal column. Note that setting `goal-column'
4138 overrides `line-move-visual' and causes this command to move by buffer
4139 lines rather than by display lines.
4141 If you are thinking of using this in a Lisp program, consider
4142 using `forward-line' instead. It is usually easier to use
4143 and more reliable (no dependence on goal column, etc.)."
4145 (or arg (setq arg 1))
4146 (if (and next-line-add-newlines (= arg 1))
4147 (if (save-excursion (end-of-line) (eobp))
4148 ;; When adding a newline, don't expand an abbrev.
4149 (let ((abbrev-mode nil))
4150 (end-of-line)
4152 (line-move arg nil nil try-vscroll))
4153 (if (called-interactively-p 'interactive)
4154 (condition-case err
4155 (line-move arg nil nil try-vscroll)
4156 ((beginning-of-buffer end-of-buffer)
4157 (signal (car err) (cdr err))))
4158 (line-move arg nil nil try-vscroll)))
4159 nil)
4161 (defun previous-line (&optional arg try-vscroll)
4162 "Move cursor vertically up ARG lines.
4163 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4164 If there is no character in the target line exactly over the current column,
4165 the cursor is positioned after the character in that line which spans this
4166 column, or at the end of the line if it is not long enough.
4168 If the variable `line-move-visual' is non-nil, this command moves
4169 by display lines. Otherwise, it moves by buffer lines, without
4170 taking variable-width characters or continued lines into account.
4173 a semipermanent goal column for this command.
4174 Then instead of trying to move exactly vertically (or as close as possible),
4175 this command moves to the specified goal column (or as close as possible).
4176 The goal column is stored in the variable `goal-column', which is nil
4177 when there is no goal column. Note that setting `goal-column'
4178 overrides `line-move-visual' and causes this command to move by buffer
4179 lines rather than by display lines.
4181 If you are thinking of using this in a Lisp program, consider using
4182 `forward-line' with a negative argument instead. It is usually easier
4183 to use and more reliable (no dependence on goal column, etc.)."
4185 (or arg (setq arg 1))
4186 (if (called-interactively-p 'interactive)
4187 (condition-case err
4188 (line-move (- arg) nil nil try-vscroll)
4189 ((beginning-of-buffer end-of-buffer)
4190 (signal (car err) (cdr err))))
4191 (line-move (- arg) nil nil try-vscroll))
4192 nil)
4194 (defcustom track-eol nil
4195 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
4196 This means moving to the end of each line moved onto.
4197 The beginning of a blank line does not count as the end of a line.
4198 This has no effect when `line-move-visual' is non-nil."
4199 :type 'boolean
4200 :group 'editing-basics)
4202 (defcustom goal-column nil
4204 A non-nil setting overrides `line-move-visual', which see."
4205 :type '(choice integer
4206 (const :tag "None" nil))
4207 :group 'editing-basics)
4208 (make-variable-buffer-local 'goal-column)
4210 (defvar temporary-goal-column 0
4211 "Current goal column for vertical motion.
4212 It is the column where point was at the start of the current run
4213 of vertical motion commands.
4215 When moving by visual lines via `line-move-visual', it is a cons
4216 cell (COL . HSCROLL), where COL is the x-position, in pixels,
4217 divided by the default column width, and HSCROLL is the number of
4218 columns by which window is scrolled from left margin.
4220 When the `track-eol' feature is doing its job, the value is
4221 `most-positive-fixnum'.")
4223 (defcustom line-move-ignore-invisible t
4225 Outline mode sets this."
4226 :type 'boolean
4227 :group 'editing-basics)
4229 (defcustom line-move-visual t
4230 "When non-nil, `line-move' moves point by visual lines.
4231 This movement is based on where the cursor is displayed on the
4232 screen, instead of relying on buffer contents alone. It takes
4233 into account variable-width characters and line continuation.
4234 If nil, `line-move' moves point by logical lines.
4235 A non-nil setting of `goal-column' overrides the value of this variable
4236 and forces movement by logical lines."
4237 :type 'boolean
4238 :group 'editing-basics
4239 :version "23.1")
4241 ;; Returns non-nil if partial move was done.
4242 (defun line-move-partial (arg noerror to-end)
4243 (if (< arg 0)
4244 ;; Move backward (up).
4245 ;; If already vscrolled, reduce vscroll
4246 (let ((vs (window-vscroll nil t)))
4247 (when (> vs (frame-char-height))
4248 (set-window-vscroll nil (- vs (frame-char-height)) t)))
4250 ;; Move forward (down).
4251 (let* ((lh (window-line-height -1))
4252 (vpos (nth 1 lh))
4253 (ypos (nth 2 lh))
4254 (rbot (nth 3 lh))
4255 py vs)
4256 (when (or (null lh)
4257 (>= rbot (frame-char-height))
4258 (<= ypos (- (frame-char-height))))
4259 (unless lh
4260 (let ((wend (pos-visible-in-window-p t nil t)))
4261 (setq rbot (nth 3 wend)
4262 vpos (nth 5 wend))))
4263 (cond
4264 ;; If last line of window is fully visible, move forward.
4265 ((or (null rbot) (= rbot 0))
4266 nil)
4267 ;; If cursor is not in the bottom scroll margin, move forward.
4268 ((and (> vpos 0)
4269 (< (setq py
4270 (or (nth 1 (window-line-height))
4271 (let ((ppos (posn-at-point)))
4272 (cdr (or (posn-actual-col-row ppos)
4273 (posn-col-row ppos))))))
4274 (min (- (window-text-height) scroll-margin 1) (1- vpos))))
4275 nil)
4276 ;; When already vscrolled, we vscroll some more if we can,
4277 ;; or clear vscroll and move forward at end of tall image.
4278 ((> (setq vs (window-vscroll nil t)) 0)
4279 (when (> rbot 0)
4280 (set-window-vscroll nil (+ vs (min rbot (frame-char-height))) t)))
4281 ;; If cursor just entered the bottom scroll margin, move forward,
4282 ;; but also vscroll one line so redisplay wont recenter.
4283 ((and (> vpos 0)
4284 (= py (min (- (window-text-height) scroll-margin 1)
4285 (1- vpos))))
4286 (set-window-vscroll nil (frame-char-height) t)
4287 (line-move-1 arg noerror to-end)
4288 t)
4289 ;; If there are lines above the last line, scroll-up one line.
4290 ((> vpos 0)
4291 (scroll-up 1)
4292 t)
4293 ;; Finally, start vscroll.
4294 (t
4295 (set-window-vscroll nil (frame-char-height) t)))))))
4298 ;; This is like line-move-1 except that it also performs
4299 ;; vertical scrolling of tall images if appropriate.
4300 ;; That is not really a clean thing to do, since it mixes
4301 ;; scrolling with cursor motion. But so far we don't have
4302 ;; a cleaner solution to the problem of making C-n do something
4303 ;; useful given a tall image.
4304 (defun line-move (arg &optional noerror to-end try-vscroll)
4305 (unless (and auto-window-vscroll try-vscroll
4306 ;; Only vscroll for single line moves
4307 (= (abs arg) 1)
4308 ;; But don't vscroll in a keyboard macro.
4309 (not defining-kbd-macro)
4310 (not executing-kbd-macro)
4311 (line-move-partial arg noerror to-end))
4312 (set-window-vscroll nil 0 t)
4313 (if (and line-move-visual (not goal-column))
4314 (line-move-visual arg noerror)
4315 (line-move-1 arg noerror to-end))))
4317 ;; Display-based alternative to line-move-1.
4318 ;; Arg says how many lines to move. The value is t if we can move the
4319 ;; specified number of lines.
4320 (defun line-move-visual (arg &optional noerror)
4321 (let ((opoint (point))
4322 (hscroll (window-hscroll))
4323 target-hscroll)
4324 ;; Check if the previous command was a line-motion command, or if
4325 ;; we were called from some other command.
4326 (if (and (consp temporary-goal-column)
4327 (memq last-command `(next-line previous-line ,this-command)))
4328 ;; If so, there's no need to reset `temporary-goal-column',
4329 ;; but we may need to hscroll.
4330 (if (or (/= (cdr temporary-goal-column) hscroll)
4331 (> (cdr temporary-goal-column) 0))
4332 (setq target-hscroll (cdr temporary-goal-column)))
4333 ;; Otherwise, we should reset `temporary-goal-column'.
4334 (let ((posn (posn-at-point)))
4335 (cond
4336 ;; Handle the `overflow-newline-into-fringe' case:
4337 ((eq (nth 1 posn) 'right-fringe)
4338 (setq temporary-goal-column (cons (- (window-width) 1) hscroll)))
4339 ((car (posn-x-y posn))
4340 (setq temporary-goal-column
4341 (cons (/ (float (car (posn-x-y posn)))
4342 (frame-char-width)) hscroll))))))
4343 (if target-hscroll
4344 (set-window-hscroll (selected-window) target-hscroll))
4345 (or (and (= (vertical-motion
4346 (cons (or goal-column
4347 (if (consp temporary-goal-column)
4348 (car temporary-goal-column)
4349 temporary-goal-column))
4350 arg))
4351 arg)
4352 (or (>= arg 0)
4353 (/= (point) opoint)
4354 ;; If the goal column lies on a display string,
4355 ;; `vertical-motion' advances the cursor to the end
4356 ;; of the string. For arg < 0, this can cause the
4357 ;; cursor to get stuck. (Bug#3020).
4358 (= (vertical-motion arg) arg)))
4359 (unless noerror
4360 (signal (if (< arg 0) 'beginning-of-buffer 'end-of-buffer)
4361 nil)))))
4363 ;; This is the guts of next-line and previous-line.
4364 ;; Arg says how many lines to move.
4365 ;; The value is t if we can move the specified number of lines.
4366 (defun line-move-1 (arg &optional noerror _to-end)
4367 ;; Don't run any point-motion hooks, and disregard intangibility,
4368 ;; for intermediate positions.
4369 (let ((inhibit-point-motion-hooks t)
4370 (opoint (point))
4371 (orig-arg arg))
4372 (if (consp temporary-goal-column)
4373 (setq temporary-goal-column (+ (car temporary-goal-column)
4374 (cdr temporary-goal-column))))
4375 (unwind-protect
4376 (progn
4377 (if (not (memq last-command '(next-line previous-line)))
4378 (setq temporary-goal-column
4379 (if (and track-eol (eolp)
4380 ;; Don't count beg of empty line as end of line
4381 ;; unless we just did explicit end-of-line.
4382 (or (not (bolp)) (eq last-command 'move-end-of-line)))
4383 most-positive-fixnum
4384 (current-column))))
4386 (if (not (or (integerp selective-display)
4387 line-move-ignore-invisible))
4388 ;; Use just newline characters.
4389 ;; Set ARG to 0 if we move as many lines as requested.
4390 (or (if (> arg 0)
4391 (progn (if (> arg 1) (forward-line (1- arg)))
4392 ;; This way of moving forward ARG lines
4393 ;; verifies that we have a newline after the last one.
4394 ;; It doesn't get confused by intangible text.
4395 (end-of-line)
4396 (if (zerop (forward-line 1))
4397 (setq arg 0)))
4398 (and (zerop (forward-line arg))
4399 (bolp)
4400 (setq arg 0)))
4401 (unless noerror
4402 (signal (if (< arg 0)
4403 'beginning-of-buffer
4404 'end-of-buffer)
4405 nil)))
4406 ;; Move by arg lines, but ignore invisible ones.
4407 (let (done)
4408 (while (and (> arg 0) (not done))
4409 ;; If the following character is currently invisible,
4410 ;; skip all characters with that same `invisible' property value.
4411 (while (and (not (eobp)) (invisible-p (point)))
4412 (goto-char (next-char-property-change (point))))
4413 ;; Move a line.
4414 ;; We don't use `end-of-line', since we want to escape
4415 ;; from field boundaries occurring exactly at point.
4416 (goto-char (constrain-to-field
4417 (let ((inhibit-field-text-motion t))
4418 (line-end-position))
4419 (point) t t
4420 'inhibit-line-move-field-capture))
4421 ;; If there's no invisibility here, move over the newline.
4422 (cond
4423 ((eobp)
4424 (if (not noerror)
4425 (signal 'end-of-buffer nil)
4426 (setq done t)))
4427 ((and (> arg 1) ;; Use vertical-motion for last move
4428 (not (integerp selective-display))
4429 (not (invisible-p (point))))
4430 ;; We avoid vertical-motion when possible
4431 ;; because that has to fontify.
4432 (forward-line 1))
4433 ;; Otherwise move a more sophisticated way.
4434 ((zerop (vertical-motion 1))
4435 (if (not noerror)
4436 (signal 'end-of-buffer nil)
4437 (setq done t))))
4438 (unless done
4439 (setq arg (1- arg))))
4440 ;; The logic of this is the same as the loop above,
4441 ;; it just goes in the other direction.
4442 (while (and (< arg 0) (not done))
4443 ;; For completely consistency with the forward-motion
4444 ;; case, we should call beginning-of-line here.
4445 ;; However, if point is inside a field and on a
4446 ;; continued line, the call to (vertical-motion -1)
4447 ;; below won't move us back far enough; then we return
4448 ;; to the same column in line-move-finish, and point
4449 ;; gets stuck -- cyd
4450 (forward-line 0)
4451 (cond
4452 ((bobp)
4453 (if (not noerror)
4454 (signal 'beginning-of-buffer nil)
4455 (setq done t)))
4456 ((and (< arg -1) ;; Use vertical-motion for last move
4457 (not (integerp selective-display))
4458 (not (invisible-p (1- (point)))))
4459 (forward-line -1))
4460 ((zerop (vertical-motion -1))
4461 (if (not noerror)
4462 (signal 'beginning-of-buffer nil)
4463 (setq done t))))
4464 (unless done
4465 (setq arg (1+ arg))
4466 (while (and ;; Don't move over previous invis lines
4467 ;; if our target is the middle of this line.
4468 (or (zerop (or goal-column temporary-goal-column))
4469 (< arg 0))
4470 (not (bobp)) (invisible-p (1- (point))))
4471 (goto-char (previous-char-property-change (point))))))))
4472 ;; This is the value the function returns.
4473 (= arg 0))
4475 (cond ((> arg 0)
4476 ;; If we did not move down as far as desired, at least go
4477 ;; to end of line. Be sure to call point-entered and
4478 ;; point-left-hooks.
4479 (let* ((npoint (prog1 (line-end-position)
4480 (goto-char opoint)))
4481 (inhibit-point-motion-hooks nil))
4482 (goto-char npoint)))
4483 ((< arg 0)
4484 ;; If we did not move up as far as desired,
4485 ;; at least go to beginning of line.
4486 (let* ((npoint (prog1 (line-beginning-position)
4487 (goto-char opoint)))
4488 (inhibit-point-motion-hooks nil))
4489 (goto-char npoint)))
4490 (t
4491 (line-move-finish (or goal-column temporary-goal-column)
4492 opoint (> orig-arg 0)))))))
4494 (defun line-move-finish (column opoint forward)
4495 (let ((repeat t))
4496 (while repeat
4497 ;; Set REPEAT to t to repeat the whole thing.
4498 (setq repeat nil)
4500 (let (new
4501 (old (point))
4502 (line-beg (line-beginning-position))
4503 (line-end
4504 ;; Compute the end of the line
4505 ;; ignoring effectively invisible newlines.
4506 (save-excursion
4507 ;; Like end-of-line but ignores fields.
4509 (while (and (not (eobp)) (invisible-p (point)))
4510 (goto-char (next-char-property-change (point)))
4512 (point))))
4514 ;; Move to the desired column.
4515 (line-move-to-column (truncate column))
4517 ;; Corner case: suppose we start out in a field boundary in
4518 ;; the middle of a continued line. When we get to
4519 ;; line-move-finish, point is at the start of a new *screen*
4520 ;; line but the same text line; then line-move-to-column would
4521 ;; move us backwards. Test using C-n with point on the "x" in
4522 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
4523 (and forward
4524 (< (point) old)
4525 (goto-char old))
4527 (setq new (point))
4529 ;; Process intangibility within a line.
4530 ;; With inhibit-point-motion-hooks bound to nil, a call to
4531 ;; goto-char moves point past intangible text.
4533 ;; However, inhibit-point-motion-hooks controls both the
4534 ;; intangibility and the point-entered/point-left hooks. The
4535 ;; following hack avoids calling the point-* hooks
4536 ;; unnecessarily. Note that we move *forward* past intangible
4537 ;; text when the initial and final points are the same.
4538 (goto-char new)
4539 (let ((inhibit-point-motion-hooks nil))
4540 (goto-char new)
4542 ;; If intangibility moves us to a different (later) place
4543 ;; in the same line, use that as the destination.
4544 (if (<= (point) line-end)
4545 (setq new (point))
4546 ;; If that position is "too late",
4547 ;; try the previous allowable position.
4548 ;; See if it is ok.
4549 (backward-char)
4550 (if (if forward
4551 ;; If going forward, don't accept the previous
4552 ;; allowable position if it is before the target line.
4553 (< line-beg (point))
4554 ;; If going backward, don't accept the previous
4555 ;; allowable position if it is still after the target line.
4556 (<= (point) line-end))
4557 (setq new (point))
4558 ;; As a last resort, use the end of the line.
4559 (setq new line-end))))
4561 ;; Now move to the updated destination, processing fields
4562 ;; as well as intangibility.
4563 (goto-char opoint)
4564 (let ((inhibit-point-motion-hooks nil))
4565 (goto-char
4566 ;; Ignore field boundaries if the initial and final
4567 ;; positions have the same `field' property, even if the
4568 ;; fields are non-contiguous. This seems to be "nicer"
4569 ;; behavior in many situations.
4570 (if (eq (get-char-property new 'field)
4571 (get-char-property opoint 'field))
4572 new
4573 (constrain-to-field new opoint t t
4574 'inhibit-line-move-field-capture))))
4576 ;; If all this moved us to a different line,
4577 ;; retry everything within that new line.
4578 (when (or (< (point) line-beg) (> (point) line-end))
4579 ;; Repeat the intangibility and field processing.
4580 (setq repeat t))))))
4582 (defun line-move-to-column (col)
4583 "Try to find column COL, considering invisibility.
4584 This function works only in certain cases,
4585 because what we really need is for `move-to-column'
4586 and `current-column' to be able to ignore invisible text."
4587 (if (zerop col)
4588 (beginning-of-line)
4589 (move-to-column col))
4591 (when (and line-move-ignore-invisible
4592 (not (bolp)) (invisible-p (1- (point))))
4593 (let ((normal-location (point))
4594 (normal-column (current-column)))
4595 ;; If the following character is currently invisible,
4596 ;; skip all characters with that same `invisible' property value.
4597 (while (and (not (eobp))
4598 (invisible-p (point)))
4599 (goto-char (next-char-property-change (point))))
4600 ;; Have we advanced to a larger column position?
4601 (if (> (current-column) normal-column)
4602 ;; We have made some progress towards the desired column.
4603 ;; See if we can make any further progress.
4604 (line-move-to-column (+ (current-column) (- col normal-column)))
4605 ;; Otherwise, go to the place we originally found
4606 ;; and move back over invisible text.
4607 ;; that will get us to the same place on the screen
4608 ;; but with a more reasonable buffer position.
4609 (goto-char normal-location)
4610 (let ((line-beg (line-beginning-position)))
4611 (while (and (not (bolp)) (invisible-p (1- (point))))
4612 (goto-char (previous-char-property-change (point) line-beg))))))))
4614 (defun move-end-of-line (arg)
4615 "Move point to end of current line as displayed.
4616 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4617 If point reaches the beginning or end of buffer, it stops there.
4619 To ignore the effects of the `intangible' text or overlay
4620 property, bind `inhibit-point-motion-hooks' to t.
4621 If there is an image in the current line, this function
4622 disregards newlines that are part of the text on which the image
4623 rests."
4624 (interactive "^p")
4625 (or arg (setq arg 1))
4626 (let (done)
4627 (while (not done)
4628 (let ((newpos
4629 (save-excursion
4630 (let ((goal-column 0)
4631 (line-move-visual nil))
4632 (and (line-move arg t)
4633 ;; With bidi reordering, we may not be at bol,
4634 ;; so make sure we are.
4636 (not (bobp))
4637 (progn
4638 (while (and (not (bobp)) (invisible-p (1- (point))))
4639 (goto-char (previous-single-char-property-change
4640 (point) 'invisible)))
4641 (backward-char 1)))
4642 (point)))))
4643 (goto-char newpos)
4644 (if (and (> (point) newpos)
4646 (backward-char 1)
4647 (if (and (> (point) newpos) (not (eobp))
4649 ;; If we skipped something intangible and now we're not
4650 ;; really at eol, keep going.
4651 (setq arg 1)
4652 (setq done t)))))))
4654 (defun move-beginning-of-line (arg)
4655 "Move point to beginning of current line as displayed.
4656 \(If there's an image in the line, this disregards newlines
4657 which are part of the text that the image rests on.)
4659 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4660 If point reaches the beginning or end of buffer, it stops there.
4661 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4662 (interactive "^p")
4663 (or arg (setq arg 1))
4665 (let ((orig (point))
4666 first-vis first-vis-field-value)
4668 ;; Move by lines, if ARG is not 1 (the default).
4669 (if (/= arg 1)
4670 (let ((line-move-visual nil))
4671 (line-move (1- arg) t)))
4673 ;; Move to beginning-of-line, ignoring fields and invisibles.
4675 (while (and (not (bobp)) (invisible-p (1- (point))))
4676 (goto-char (previous-char-property-change (point)))
4679 ;; Now find first visible char in the line
4680 (while (and (not (eobp)) (invisible-p (point)))
4681 (goto-char (next-char-property-change (point))))
4682 (setq first-vis (point))
4684 ;; See if fields would stop us from reaching FIRST-VIS.
4685 (setq first-vis-field-value
4686 (constrain-to-field first-vis orig (/= arg 1) t nil))
4688 (goto-char (if (/= first-vis-field-value first-vis)
4689 ;; If yes, obey them.
4690 first-vis-field-value
4691 ;; Otherwise, move to START with attention to fields.
4692 ;; (It is possible that fields never matter in this case.)
4693 (constrain-to-field (point) orig
4694 (/= arg 1) t nil)))))
4697 ;; Many people have said they rarely use this feature, and often type
4698 ;; it by accident. Maybe it shouldn't even be on a key.
4699 (put 'set-goal-column 'disabled t)
4701 (defun set-goal-column (arg)
4703 Those commands will move to this position in the line moved to
4704 rather than trying to keep the same horizontal position.
4705 With a non-nil argument ARG, clears out the goal column
4707 The goal column is stored in the variable `goal-column'."
4708 (interactive "P")
4709 (if arg
4710 (progn
4711 (setq goal-column nil)
4712 (message "No goal column"))
4713 (setq goal-column (current-column))
4714 ;; The older method below can be erroneous if `set-goal-column' is bound
4715 ;; to a sequence containing %
4716 ;;(message (substitute-command-keys
4718 ;;goal-column)
4719 (message "%s"
4720 (concat
4721 (format "Goal column %d " goal-column)
4722 (substitute-command-keys
4725 )
4726 nil)
4727 \f
4728 ;;; Editing based on visual lines, as opposed to logical lines.
4730 (defun end-of-visual-line (&optional n)
4731 "Move point to end of current visual line.
4732 With argument N not nil or 1, move forward N - 1 visual lines first.
4733 If point reaches the beginning or end of buffer, it stops there.
4734 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4735 (interactive "^p")
4736 (or n (setq n 1))
4737 (if (/= n 1)
4738 (let ((line-move-visual t))
4739 (line-move (1- n) t)))
4740 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
4741 ;; constrain to field boundaries, so we don't either.
4742 (vertical-motion (cons (window-width) 0)))
4744 (defun beginning-of-visual-line (&optional n)
4745 "Move point to beginning of current visual line.
4746 With argument N not nil or 1, move forward N - 1 visual lines first.
4747 If point reaches the beginning or end of buffer, it stops there.
4748 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4749 (interactive "^p")
4750 (or n (setq n 1))
4751 (let ((opoint (point)))
4752 (if (/= n 1)
4753 (let ((line-move-visual t))
4754 (line-move (1- n) t)))
4755 (vertical-motion 0)
4756 ;; Constrain to field boundaries, like `move-beginning-of-line'.
4757 (goto-char (constrain-to-field (point) opoint (/= n 1)))))
4759 (defun kill-visual-line (&optional arg)
4760 "Kill the rest of the visual line.
4761 With prefix argument ARG, kill that many visual lines from point.
4762 If ARG is negative, kill visual lines backward.
4763 If ARG is zero, kill the text before point on the current visual
4764 line.
4766 If you want to append the killed line to the last killed text,
4769 If the buffer is read-only, Emacs will beep and refrain from deleting
4770 the line, but put the line in the kill ring anyway. This means that
4771 you can use this command to copy text from a read-only buffer.
4772 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4773 even beep.)"
4774 (interactive "P")
4775 ;; Like in `kill-line', it's better to move point to the other end
4776 ;; of the kill before killing.
4777 (let ((opoint (point))
4778 (kill-whole-line (and kill-whole-line (bolp))))
4779 (if arg
4780 (vertical-motion (prefix-numeric-value arg))
4781 (end-of-visual-line 1)
4782 (if (= (point) opoint)
4783 (vertical-motion 1)
4784 ;; Skip any trailing whitespace at the end of the visual line.
4785 ;; We used to do this only if `show-trailing-whitespace' is
4786 ;; nil, but that's wrong; the correct thing would be to check
4787 ;; whether the trailing whitespace is highlighted. But, it's
4788 ;; OK to just do this unconditionally.
4791 (1+ (point))
4792 (point)))))
4794 (defun next-logical-line (&optional arg try-vscroll)
4795 "Move cursor vertically down ARG lines.
4796 This is identical to `next-line', except that it always moves
4797 by logical lines instead of visual lines, ignoring the value of
4798 the variable `line-move-visual'."
4800 (let ((line-move-visual nil))
4801 (with-no-warnings
4802 (next-line arg try-vscroll))))
4804 (defun previous-logical-line (&optional arg try-vscroll)
4805 "Move cursor vertically up ARG lines.
4806 This is identical to `previous-line', except that it always moves
4807 by logical lines instead of visual lines, ignoring the value of
4808 the variable `line-move-visual'."
4810 (let ((line-move-visual nil))
4811 (with-no-warnings
4812 (previous-line arg try-vscroll))))
4814 (defgroup visual-line nil
4815 "Editing based on visual lines."
4816 :group 'convenience
4817 :version "23.1")
4819 (defvar visual-line-mode-map
4820 (let ((map (make-sparse-keymap)))
4821 (define-key map [remap kill-line] 'kill-visual-line)
4822 (define-key map [remap move-beginning-of-line] 'beginning-of-visual-line)
4823 (define-key map [remap move-end-of-line] 'end-of-visual-line)
4824 ;; These keybindings interfere with xterm function keys. Are
4825 ;; there any other suitable bindings?
4826 ;; (define-key map "\M-[" 'previous-logical-line)
4827 ;; (define-key map "\M-]" 'next-logical-line)
4828 map))
4830 (defcustom visual-line-fringe-indicators '(nil nil)
4831 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
4832 The value should be a list of the form (LEFT RIGHT), where LEFT
4833 and RIGHT are symbols representing the bitmaps to display, to
4834 indicate wrapped lines, in the left and right fringes respectively.
4835 See also `fringe-indicator-alist'.
4836 The default is not to display fringe indicators for wrapped lines.
4837 This variable does not affect fringe indicators displayed for
4838 other purposes."
4839 :type '(list (choice (const :tag "Hide left indicator" nil)
4840 (const :tag "Left curly arrow" left-curly-arrow)
4841 (symbol :tag "Other bitmap"))
4842 (choice (const :tag "Hide right indicator" nil)
4843 (const :tag "Right curly arrow" right-curly-arrow)
4844 (symbol :tag "Other bitmap")))
4845 :set (lambda (symbol value)
4846 (dolist (buf (buffer-list))
4847 (with-current-buffer buf
4848 (when (and (boundp 'visual-line-mode)
4849 (symbol-value 'visual-line-mode))
4850 (setq fringe-indicator-alist
4851 (cons (cons 'continuation value)
4852 (assq-delete-all
4853 'continuation
4854 (copy-tree fringe-indicator-alist)))))))
4855 (set-default symbol value)))
4857 (defvar visual-line--saved-state nil)
4859 (define-minor-mode visual-line-mode
4860 "Redefine simple editing commands to act on visual lines, not logical lines.
4861 This also turns on `word-wrap' in the buffer."
4862 :keymap visual-line-mode-map
4863 :group 'visual-line
4864 :lighter " Wrap"
4865 (if visual-line-mode
4866 (progn
4867 (set (make-local-variable 'visual-line--saved-state) nil)
4868 ;; Save the local values of some variables, to be restored if
4869 ;; visual-line-mode is turned off.
4870 (dolist (var '(line-move-visual truncate-lines
4871 truncate-partial-width-windows
4872 word-wrap fringe-indicator-alist))
4873 (if (local-variable-p var)
4874 (push (cons var (symbol-value var))
4875 visual-line--saved-state)))
4876 (set (make-local-variable 'line-move-visual) t)
4877 (set (make-local-variable 'truncate-partial-width-windows) nil)
4878 (setq truncate-lines nil
4879 word-wrap t
4880 fringe-indicator-alist
4881 (cons (cons 'continuation visual-line-fringe-indicators)
4882 fringe-indicator-alist)))
4883 (kill-local-variable 'line-move-visual)
4884 (kill-local-variable 'word-wrap)
4885 (kill-local-variable 'truncate-lines)
4886 (kill-local-variable 'truncate-partial-width-windows)
4887 (kill-local-variable 'fringe-indicator-alist)
4888 (dolist (saved visual-line--saved-state)
4889 (set (make-local-variable (car saved)) (cdr saved)))
4890 (kill-local-variable 'visual-line--saved-state)))
4892 (defun turn-on-visual-line-mode ()
4893 (visual-line-mode 1))
4895 (define-globalized-minor-mode global-visual-line-mode
4896 visual-line-mode turn-on-visual-line-mode
4897 :lighter " vl")
4899 \f
4900 (defun transpose-chars (arg)
4901 "Interchange characters around point, moving forward one character.
4902 With prefix arg ARG, effect is to take character before point
4903 and drag it forward past ARG other characters (backward if ARG negative).
4904 If no argument and at end of line, the previous two chars are exchanged."
4905 (interactive "*P")
4906 (and (null arg) (eolp) (forward-char -1))
4907 (transpose-subr 'forward-char (prefix-numeric-value arg)))
4909 (defun transpose-words (arg)
4910 "Interchange words around point, leaving point at end of them.
4911 With prefix arg ARG, effect is to take word before or around point
4912 and drag it forward past ARG other words (backward if ARG negative).
4913 If ARG is zero, the words around or after point and around or after mark
4914 are interchanged."
4915 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
4916 (interactive "*p")
4917 (transpose-subr 'forward-word arg))
4919 (defun transpose-sexps (arg)
4921 Does not work on a sexp that point is in the middle of
4922 if it is a list or string."
4923 (interactive "*p")
4924 (transpose-subr
4925 (lambda (arg)
4926 ;; Here we should try to simulate the behavior of
4927 ;; (cons (progn (forward-sexp x) (point))
4928 ;; (progn (forward-sexp (- x)) (point)))
4929 ;; Except that we don't want to rely on the second forward-sexp
4930 ;; putting us back to where we want to be, since forward-sexp-function
4931 ;; might do funny things like infix-precedence.
4932 (if (if (> arg 0)
4934 (and (not (bobp))
4936 ;; Jumping over a symbol. We might be inside it, mind you.
4937 (progn (funcall (if (> arg 0)
4938 'skip-syntax-backward 'skip-syntax-forward)
4939 "w_")
4940 (cons (save-excursion (forward-sexp arg) (point)) (point)))
4941 ;; Otherwise, we're between sexps. Take a step back before jumping
4942 ;; to make sure we'll obey the same precedence no matter which direction
4943 ;; we're going.
4944 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
4945 (cons (save-excursion (forward-sexp arg) (point))
4946 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
4947 (not (zerop (funcall (if (> arg 0)
4948 'skip-syntax-forward
4949 'skip-syntax-backward)
4950 ".")))))
4951 (point)))))
4952 arg 'special))
4954 (defun transpose-lines (arg)
4955 "Exchange current line and previous line, leaving point after both.
4956 With argument ARG, takes previous line and moves it past ARG lines.
4957 With argument 0, interchanges line point is in with line mark is in."
4958 (interactive "*p")
4959 (transpose-subr (function
4960 (lambda (arg)
4961 (if (> arg 0)
4962 (progn
4963 ;; Move forward over ARG lines,
4964 ;; but create newlines if necessary.
4965 (setq arg (forward-line arg))
4967 (setq arg (1+ arg)))
4968 (if (> arg 0)
4969 (newline arg)))
4970 (forward-line arg))))
4971 arg))
4973 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
4974 ;; which seems inconsistent with the ARG /= 0 case.
4975 ;; FIXME document SPECIAL.
4976 (defun transpose-subr (mover arg &optional special)
4977 "Subroutine to do the work of transposing objects.
4978 Works for lines, sentences, paragraphs, etc. MOVER is a function that
4979 moves forward by units of the given object (e.g. forward-sentence,
4980 forward-paragraph). If ARG is zero, exchanges the current object
4981 with the one containing mark. If ARG is an integer, moves the
4982 current object past ARG following (if ARG is positive) or
4983 preceding (if ARG is negative) objects, leaving point after the
4984 current object."
4985 (let ((aux (if special mover
4986 (lambda (x)
4987 (cons (progn (funcall mover x) (point))
4988 (progn (funcall mover (- x)) (point))))))
4989 pos1 pos2)
4990 (cond
4991 ((= arg 0)
4992 (save-excursion
4993 (setq pos1 (funcall aux 1))
4994 (goto-char (or (mark) (error "No mark set in this buffer")))
4995 (setq pos2 (funcall aux 1))
4996 (transpose-subr-1 pos1 pos2))
4997 (exchange-point-and-mark))
4998 ((> arg 0)
4999 (setq pos1 (funcall aux -1))
5000 (setq pos2 (funcall aux arg))
5001 (transpose-subr-1 pos1 pos2)
5002 (goto-char (car pos2)))
5003 (t
5004 (setq pos1 (funcall aux -1))
5005 (goto-char (car pos1))
5006 (setq pos2 (funcall aux arg))
5007 (transpose-subr-1 pos1 pos2)))))
5009 (defun transpose-subr-1 (pos1 pos2)
5010 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
5011 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
5012 (when (> (car pos1) (car pos2))
5013 (let ((swap pos1))
5014 (setq pos1 pos2 pos2 swap)))
5015 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
5016 (atomic-change-group
5017 (let (word2)
5018 ;; FIXME: We first delete the two pieces of text, so markers that
5019 ;; used to point to after the text end up pointing to before it :-(
5020 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
5021 (goto-char (car pos2))
5022 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
5023 (goto-char (car pos1))
5024 (insert word2))))
5025 \f
5026 (defun backward-word (&optional arg)
5027 "Move backward until encountering the beginning of a word.
5028 With argument ARG, do this that many times."
5029 (interactive "^p")
5030 (forward-word (- (or arg 1))))
5032 (defun mark-word (&optional arg allow-extend)
5033 "Set mark ARG words away from point.
5035 move to with the same argument.
5036 Interactively, if this command is repeated
5037 or (in Transient Mark mode) if the mark is active,
5038 it marks the next ARG words after the ones already marked."
5040 (cond ((and allow-extend
5041 (or (and (eq last-command this-command) (mark t))
5042 (region-active-p)))
5043 (setq arg (if arg (prefix-numeric-value arg)
5044 (if (< (mark) (point)) -1 1)))
5045 (set-mark
5046 (save-excursion
5047 (goto-char (mark))
5048 (forward-word arg)
5049 (point))))
5050 (t
5051 (push-mark
5052 (save-excursion
5053 (forward-word (prefix-numeric-value arg))
5054 (point))
5055 nil t))))
5057 (defun kill-word (arg)
5058 "Kill characters forward until encountering the end of a word.
5059 With argument ARG, do this that many times."
5060 (interactive "p")
5061 (kill-region (point) (progn (forward-word arg) (point))))
5063 (defun backward-kill-word (arg)
5064 "Kill characters backward until encountering the beginning of a word.
5065 With argument ARG, do this that many times."
5066 (interactive "p")
5067 (kill-word (- arg)))
5069 (defun current-word (&optional strict really-word)
5070 "Return the symbol or word that point is on (or a nearby one) as a string.
5071 The return value includes no text properties.
5072 If optional arg STRICT is non-nil, return nil unless point is within
5073 or adjacent to a symbol or word. In all cases the value can be nil
5074 if there is no word nearby.
5075 The function, belying its name, normally finds a symbol.
5076 If optional arg REALLY-WORD is non-nil, it finds just a word."
5077 (save-excursion
5078 (let* ((oldpoint (point)) (start (point)) (end (point))
5079 (syntaxes (if really-word "w" "w_"))
5080 (not-syntaxes (concat "^" syntaxes)))
5081 (skip-syntax-backward syntaxes) (setq start (point))
5082 (goto-char oldpoint)
5083 (skip-syntax-forward syntaxes) (setq end (point))
5084 (when (and (eq start oldpoint) (eq end oldpoint)
5085 ;; Point is neither within nor adjacent to a word.
5086 (not strict))
5087 ;; Look for preceding word in same line.
5088 (skip-syntax-backward not-syntaxes (line-beginning-position))
5089 (if (bolp)
5090 ;; No preceding word in same line.
5091 ;; Look for following word in same line.
5092 (progn
5093 (skip-syntax-forward not-syntaxes (line-end-position))
5094 (setq start (point))
5095 (skip-syntax-forward syntaxes)
5096 (setq end (point)))
5097 (setq end (point))
5098 (skip-syntax-backward syntaxes)
5099 (setq start (point))))
5100 ;; If we found something nonempty, return it as a string.
5101 (unless (= start end)
5102 (buffer-substring-no-properties start end)))))
5103 \f
5104 (defcustom fill-prefix nil
5105 "String for filling to insert at front of new line, or nil for none."
5106 :type '(choice (const :tag "None" nil)
5107 string)
5108 :group 'fill)
5109 (make-variable-buffer-local 'fill-prefix)
5110 (put 'fill-prefix 'safe-local-variable 'string-or-null-p)
5112 (defcustom auto-fill-inhibit-regexp nil
5113 "Regexp to match lines which should not be auto-filled."
5114 :type '(choice (const :tag "None" nil)
5115 regexp)
5116 :group 'fill)
5118 (defun do-auto-fill ()
5119 "The default value for `normal-auto-fill-function'.
5120 This is the default auto-fill function, some major modes use a different one.
5121 Returns t if it really did any work."
5122 (let (fc justify give-up
5123 (fill-prefix fill-prefix))
5124 (if (or (not (setq justify (current-justification)))
5125 (null (setq fc (current-fill-column)))
5126 (and (eq justify 'left)
5127 (<= (current-column) fc))
5128 (and auto-fill-inhibit-regexp
5129 (save-excursion (beginning-of-line)
5130 (looking-at auto-fill-inhibit-regexp))))
5131 nil ;; Auto-filling not required
5132 (if (memq justify '(full center right))
5133 (save-excursion (unjustify-current-line)))
5135 ;; Choose a fill-prefix automatically.
5136 (when (and adaptive-fill-mode
5137 (or (null fill-prefix) (string= fill-prefix "")))
5138 (let ((prefix
5139 (fill-context-prefix
5140 (save-excursion (fill-forward-paragraph -1) (point))
5141 (save-excursion (fill-forward-paragraph 1) (point)))))
5142 (and prefix (not (equal prefix ""))
5143 ;; Use auto-indentation rather than a guessed empty prefix.
5144 (not (and fill-indent-according-to-mode
5146 (setq fill-prefix prefix))))
5148 (while (and (not give-up) (> (current-column) fc))
5149 ;; Determine where to split the line.
5150 (let* (after-prefix
5151 (fill-point
5152 (save-excursion
5153 (beginning-of-line)
5154 (setq after-prefix (point))
5155 (and fill-prefix
5156 (looking-at (regexp-quote fill-prefix))
5157 (setq after-prefix (match-end 0)))
5158 (move-to-column (1+ fc))
5159 (fill-move-to-break-point after-prefix)
5160 (point))))
5162 ;; See whether the place we found is any good.
5163 (if (save-excursion
5164 (goto-char fill-point)
5165 (or (bolp)
5166 ;; There is no use breaking at end of line.
5167 (save-excursion (skip-chars-forward " ") (eolp))
5168 ;; It is futile to split at the end of the prefix
5169 ;; since we would just insert the prefix again.
5170 (and after-prefix (<= (point) after-prefix))
5171 ;; Don't split right after a comment starter
5172 ;; since we would just make another comment starter.
5173 (and comment-start-skip
5174 (let ((limit (point)))
5175 (beginning-of-line)
5176 (and (re-search-forward comment-start-skip
5177 limit t)
5178 (eq (point) limit))))))
5179 ;; No good place to break => stop trying.
5180 (setq give-up t)
5181 ;; Ok, we have a useful place to break the line. Do it.
5182 (let ((prev-column (current-column)))
5183 ;; If point is at the fill-point, do not `save-excursion'.
5184 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
5185 ;; point will end up before it rather than after it.
5186 (if (save-excursion
5188 (= (point) fill-point))
5189 (default-indent-new-line t)
5190 (save-excursion
5191 (goto-char fill-point)
5192 (default-indent-new-line t)))
5193 ;; Now do justification, if required
5194 (if (not (eq justify 'left))
5195 (save-excursion
5196 (end-of-line 0)
5197 (justify-current-line justify nil t)))
5198 ;; If making the new line didn't reduce the hpos of
5199 ;; the end of the line, then give up now;
5200 ;; trying again will not help.
5201 (if (>= (current-column) prev-column)
5202 (setq give-up t))))))
5203 ;; Justify last line.
5204 (justify-current-line justify t t)
5205 t)))
5207 (defvar comment-line-break-function 'comment-indent-new-line
5208 "*Mode-specific function which line breaks and continues a comment.
5209 This function is called during auto-filling when a comment syntax
5210 is defined.
5211 The function should take a single optional argument, which is a flag
5212 indicating whether it should use soft newlines.")
5214 (defun default-indent-new-line (&optional soft)
5215 "Break line at point and indent.
5216 If a comment syntax is defined, call `comment-indent-new-line'.
5218 The inserted newline is marked hard if variable `use-hard-newlines' is true,
5219 unless optional argument SOFT is non-nil."
5220 (interactive)
5221 (if comment-start
5222 (funcall comment-line-break-function soft)
5223 ;; Insert the newline before removing empty space so that markers
5224 ;; get preserved better.
5226 (save-excursion (forward-char -1) (delete-horizontal-space))
5227 (delete-horizontal-space)
5229 (if (and fill-prefix (not adaptive-fill-mode))
5230 ;; Blindly trust a non-adaptive fill-prefix.
5231 (progn
5232 (indent-to-left-margin)
5233 (insert-before-markers-and-inherit fill-prefix))
5235 (cond
5236 ;; If there's an adaptive prefix, use it unless we're inside
5237 ;; a comment and the prefix is not a comment starter.
5238 (fill-prefix
5239 (indent-to-left-margin)
5240 (insert-and-inherit fill-prefix))
5241 ;; If we're not inside a comment, just try to indent.
5242 (t (indent-according-to-mode))))))
5244 (defvar normal-auto-fill-function 'do-auto-fill
5245 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
5246 Some major modes set this.")
5248 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
5249 ;; `functions' and `hooks' are usually unsafe to set, but setting
5250 ;; auto-fill-function to nil in a file-local setting is safe and
5251 ;; can be useful to prevent auto-filling.
5252 (put 'auto-fill-function 'safe-local-variable 'null)
5254 (define-minor-mode auto-fill-mode
5255 "Toggle Auto Fill mode.
5256 With ARG, turn Auto Fill mode on if and only if ARG is positive.
5257 In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
5258 automatically breaks the line at a previous space.
5260 When `auto-fill-mode' is on, the `auto-fill-function' variable is
5261 non-`nil'.
5263 The value of `normal-auto-fill-function' specifies the function to use
5264 for `auto-fill-function' when turning Auto Fill mode on."
5265 :variable (eq auto-fill-function normal-auto-fill-function))
5267 ;; This holds a document string used to document auto-fill-mode.
5268 (defun auto-fill-function ()
5269 "Automatically break line at a previous space, in insertion of text."
5270 nil)
5272 (defun turn-on-auto-fill ()
5273 "Unconditionally turn on Auto Fill mode."
5274 (auto-fill-mode 1))
5276 (defun turn-off-auto-fill ()
5277 "Unconditionally turn off Auto Fill mode."
5278 (auto-fill-mode -1))
5280 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
5282 (defun set-fill-column (arg)
5283 "Set `fill-column' to specified argument.
5286 (interactive
5287 (list (or current-prefix-arg
5288 ;; We used to use current-column silently, but C-x f is too easily
5289 ;; typed as a typo for C-x C-f, so we turned it into an error and
5290 ;; now an interactive prompt.
5291 (read-number "Set fill-column to: " (current-column)))))
5292 (if (consp arg)
5293 (setq arg (current-column)))
5294 (if (not (integerp arg))
5295 ;; Disallow missing argument; it's probably a typo for C-x C-f.
5296 (error "set-fill-column requires an explicit argument")
5297 (message "Fill column set to %d (was %d)" arg fill-column)
5298 (setq fill-column arg)))
5299 \f
5300 (defun set-selective-display (arg)
5301 "Set `selective-display' to ARG; clear it if no arg.
5302 When the value of `selective-display' is a number > 0,
5303 lines whose indentation is >= that value are not displayed.
5304 The variable `selective-display' has a separate value for each buffer."
5305 (interactive "P")
5306 (if (eq selective-display t)
5307 (error "selective-display already in use for marked lines"))
5308 (let ((current-vpos
5309 (save-restriction
5310 (narrow-to-region (point-min) (point))
5311 (goto-char (window-start))
5312 (vertical-motion (window-height)))))
5313 (setq selective-display
5314 (and arg (prefix-numeric-value arg)))
5315 (recenter current-vpos))
5316 (set-window-start (selected-window) (window-start (selected-window)))
5317 (princ "selective-display set to " t)
5318 (prin1 selective-display t)
5319 (princ "." t))
5321 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
5323 (defun toggle-truncate-lines (&optional arg)
5324 "Toggle truncating of long lines for the current buffer.
5325 When truncating is off, long lines are folded.
5326 With prefix argument ARG, truncate long lines if ARG is positive,
5327 otherwise fold them. Note that in side-by-side windows, this
5328 command has no effect if `truncate-partial-width-windows' is
5329 non-nil."
5330 (interactive "P")
5331 (setq truncate-lines
5332 (if (null arg)
5333 (not truncate-lines)
5334 (> (prefix-numeric-value arg) 0)))
5335 (force-mode-line-update)
5336 (unless truncate-lines
5337 (let ((buffer (current-buffer)))
5338 (walk-windows (lambda (window)
5339 (if (eq buffer (window-buffer window))
5340 (set-window-hscroll window 0)))
5341 nil t)))
5342 (message "Truncate long lines %s"
5343 (if truncate-lines "enabled" "disabled")))
5345 (defun toggle-word-wrap (&optional arg)
5346 "Toggle whether to use word-wrapping for continuation lines.
5347 With prefix argument ARG, wrap continuation lines at word boundaries
5348 if ARG is positive, otherwise wrap them at the right screen edge.
5349 This command toggles the value of `word-wrap'. It has no effect
5350 if long lines are truncated."
5351 (interactive "P")
5352 (setq word-wrap
5353 (if (null arg)
5354 (not word-wrap)
5355 (> (prefix-numeric-value arg) 0)))
5356 (force-mode-line-update)
5357 (message "Word wrapping %s"
5358 (if word-wrap "enabled" "disabled")))
5360 (defvar overwrite-mode-textual (purecopy " Ovwrt")
5361 "The string displayed in the mode line when in overwrite mode.")
5362 (defvar overwrite-mode-binary (purecopy " Bin Ovwrt")
5363 "The string displayed in the mode line when in binary overwrite mode.")
5365 (define-minor-mode overwrite-mode
5366 "Toggle overwrite mode.
5367 With prefix argument ARG, turn overwrite mode on if ARG is positive,
5368 otherwise turn it off. In overwrite mode, printing characters typed
5369 in replace existing text on a one-for-one basis, rather than pushing
5370 it to the right. At the end of a line, such characters extend the line.
5371 Before a tab, such characters insert until the tab is filled in.
5373 is supposed to make it easier to insert characters when necessary."
5374 :variable (eq overwrite-mode 'overwrite-mode-textual))
5376 (define-minor-mode binary-overwrite-mode
5377 "Toggle binary overwrite mode.
5378 With prefix argument ARG, turn binary overwrite mode on if ARG is
5379 positive, otherwise turn it off. In binary overwrite mode, printing
5380 characters typed in replace existing text. Newlines are not treated
5381 specially, so typing at the end of a line joins the line to the next,
5382 with the typed character between them. Typing before a tab character
5384 replaces the text at the cursor, just as ordinary typing characters do.
5386 Note that binary overwrite mode is not its own minor mode; it is a
5387 specialization of overwrite mode, entered by setting the
5388 `overwrite-mode' variable to `overwrite-mode-binary'."
5389 :variable (eq overwrite-mode 'overwrite-mode-binary))
5391 (define-minor-mode line-number-mode
5392 "Toggle Line Number mode.
5393 With ARG, turn Line Number mode on if ARG is positive, otherwise
5394 turn it off. When Line Number mode is enabled, the line number
5395 appears in the mode line.
5397 Line numbers do not appear for very large buffers and buffers
5398 with very long lines; see variables `line-number-display-limit'
5399 and `line-number-display-limit-width'."
5400 :init-value t :global t :group 'mode-line)
5402 (define-minor-mode column-number-mode
5403 "Toggle Column Number mode.
5404 With ARG, turn Column Number mode on if ARG is positive,
5405 otherwise turn it off. When Column Number mode is enabled, the
5406 column number appears in the mode line."
5407 :global t :group 'mode-line)
5409 (define-minor-mode size-indication-mode
5410 "Toggle Size Indication mode.
5411 With ARG, turn Size Indication mode on if ARG is positive,
5412 otherwise turn it off. When Size Indication mode is enabled, the
5413 size of the accessible part of the buffer appears in the mode line."
5414 :global t :group 'mode-line)
5416 (define-minor-mode auto-save-mode
5417 "Toggle auto-saving of contents of current buffer.
5418 With prefix argument ARG, turn auto-saving on if positive, else off."
5419 :variable ((and buffer-auto-save-file-name
5420 ;; If auto-save is off because buffer has shrunk,
5421 ;; then toggling should turn it on.
5422 (>= buffer-saved-size 0))
5423 . (lambda (val)
5424 (setq buffer-auto-save-file-name
5425 (cond
5426 ((null val) nil)
5427 ((and buffer-file-name auto-save-visited-file-name
5428 (not buffer-read-only))
5429 buffer-file-name)
5430 (t (make-auto-save-file-name))))))
5431 ;; If -1 was stored here, to temporarily turn off saving,
5432 ;; turn it back on.
5433 (and (< buffer-saved-size 0)
5434 (setq buffer-saved-size 0)))
5435 \f
5436 (defgroup paren-blinking nil
5437 "Blinking matching of parens and expressions."
5438 :prefix "blink-matching-"
5439 :group 'paren-matching)
5441 (defcustom blink-matching-paren t
5442 "Non-nil means show matching open-paren when close-paren is inserted."
5443 :type 'boolean
5444 :group 'paren-blinking)
5446 (defcustom blink-matching-paren-on-screen t
5447 "Non-nil means show matching open-paren when it is on screen.
5448 If nil, don't show it (but the open-paren can still be shown
5449 when it is off screen).
5451 This variable has no effect if `blink-matching-paren' is nil.
5452 \(In that case, the open-paren is never shown.)
5453 It is also ignored if `show-paren-mode' is enabled."
5454 :type 'boolean
5455 :group 'paren-blinking)
5457 (defcustom blink-matching-paren-distance (* 100 1024)
5458 "If non-nil, maximum distance to search backwards for matching open-paren.
5459 If nil, search stops at the beginning of the accessible portion of the buffer."
5460 :version "23.2" ; 25->100k
5461 :type '(choice (const nil) integer)
5462 :group 'paren-blinking)
5464 (defcustom blink-matching-delay 1
5465 "Time in seconds to delay after showing a matching paren."
5466 :type 'number
5467 :group 'paren-blinking)
5469 (defcustom blink-matching-paren-dont-ignore-comments nil
5470 "If nil, `blink-matching-paren' ignores comments.
5471 More precisely, when looking for the matching parenthesis,
5472 it skips the contents of comments that end before point."
5473 :type 'boolean
5474 :group 'paren-blinking)
5476 (defun blink-matching-check-mismatch (start end)
5477 "Return whether or not START...END are matching parens.
5478 END is the current point and START is the blink position.
5479 START might be nil if no matching starter was found.
5480 Returns non-nil if we find there is a mismatch."
5481 (let* ((end-syntax (syntax-after (1- end)))
5482 (matching-paren (and (consp end-syntax)
5483 (eq (syntax-class end-syntax) 5)
5484 (cdr end-syntax))))
5485 ;; For self-matched chars like " and $, we can't know when they're
5486 ;; mismatched or unmatched, so we can only do it for parens.
5487 (when matching-paren
5488 (not (and start
5489 (or
5490 (eq (char-after start) matching-paren)
5491 ;; The cdr might hold a new paren-class info rather than
5492 ;; a matching-char info, in which case the two CDRs
5493 ;; should match.
5494 (eq matching-paren (cdr-safe (syntax-after start)))))))))
5496 (defvar blink-matching-check-function #'blink-matching-check-mismatch
5497 "Function to check parentheses mismatches.
5498 The function takes two arguments (START and END) where START is the
5499 position just before the opening token and END is the position right after.
5500 START can be nil, if it was not found.
5501 The function should return non-nil if the two tokens do not match.")
5503 (defun blink-matching-open ()
5504 "Move cursor momentarily to the beginning of the sexp before point."
5505 (interactive)
5506 (when (and (not (bobp))
5507 blink-matching-paren)
5508 (let* ((oldpos (point))
5509 (message-log-max nil) ; Don't log messages about paren matching.
5510 (blinkpos
5511 (save-excursion
5512 (save-restriction
5513 (if blink-matching-paren-distance
5514 (narrow-to-region
5515 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
5516 (- (point) blink-matching-paren-distance))
5517 oldpos))
5518 (let ((parse-sexp-ignore-comments
5519 (and parse-sexp-ignore-comments
5520 (not blink-matching-paren-dont-ignore-comments))))
5521 (condition-case ()
5522 (progn
5523 (forward-sexp -1)
5524 ;; backward-sexp skips backward over prefix chars,
5525 ;; so move back to the matching paren.
5526 (while (and (< (point) (1- oldpos))
5527 (let ((code (syntax-after (point))))
5528 (or (eq (syntax-class code) 6)
5529 (eq (logand 1048576 (car code))
5530 1048576))))
5531 (forward-char 1))
5532 (point))
5533 (error nil))))))
5534 (mismatch (funcall blink-matching-check-function blinkpos oldpos)))
5535 (cond
5536 (mismatch
5537 (if blinkpos
5538 (if (minibufferp)
5539 (minibuffer-message "Mismatched parentheses")
5540 (message "Mismatched parentheses"))
5541 (if (minibufferp)
5542 (minibuffer-message "No matching parenthesis found")
5543 (message "No matching parenthesis found"))))
5544 ((not blinkpos) nil)
5545 ((pos-visible-in-window-p blinkpos)
5546 ;; Matching open within window, temporarily move to blinkpos but only
5547 ;; if `blink-matching-paren-on-screen' is non-nil.
5548 (and blink-matching-paren-on-screen
5549 (not show-paren-mode)
5550 (save-excursion
5551 (goto-char blinkpos)
5552 (sit-for blink-matching-delay))))
5553 (t
5554 (save-excursion
5555 (goto-char blinkpos)
5556 (let ((open-paren-line-string
5557 ;; Show what precedes the open in its line, if anything.
5558 (cond
5560 (buffer-substring (line-beginning-position)
5561 (1+ blinkpos)))
5562 ;; Show what follows the open in its line, if anything.
5563 ((save-excursion
5564 (forward-char 1)
5566 (not (eolp)))
5567 (buffer-substring blinkpos
5568 (line-end-position)))
5569 ;; Otherwise show the previous nonblank line,
5570 ;; if there is one.
5572 (concat
5573 (buffer-substring (progn
5575 (line-beginning-position))
5576 (progn (end-of-line)
5578 (point)))
5579 ;; Replace the newline and other whitespace with `...'.
5580 "..."
5581 (buffer-substring blinkpos (1+ blinkpos))))
5582 ;; There is nothing to show except the char itself.
5583 (t (buffer-substring blinkpos (1+ blinkpos))))))
5584 (message "Matches %s"
5585 (substring-no-properties open-paren-line-string)))))))))
5587 (defvar blink-paren-function 'blink-matching-open
5588 "Function called, if non-nil, whenever a close parenthesis is inserted.
5589 More precisely, a char with closeparen syntax is self-inserted.")
5591 (defun blink-paren-post-self-insert-function ()
5592 (when (and (eq (char-before) last-command-event) ; Sanity check.
5593 (memq (char-syntax last-command-event) '(?\) ?\$))
5594 blink-paren-function
5595 (not executing-kbd-macro)
5596 (not noninteractive)
5597 ;; Verify an even number of quoting characters precede the close.
5598 (= 1 (logand 1 (- (point)
5599 (save-excursion
5600 (forward-char -1)
5602 (point))))))
5603 (funcall blink-paren-function)))
5605 (add-hook 'post-self-insert-hook #'blink-paren-post-self-insert-function
5606 ;; Most likely, this hook is nil, so this arg doesn't matter,
5607 ;; but I use it as a reminder that this function usually
5608 ;; likes to be run after others since it does `sit-for'.
5609 'append)
5610 \f
5611 ;; This executes C-g typed while Emacs is waiting for a command.
5612 ;; Quitting out of a program does not go through here;
5613 ;; that happens in the QUIT macro at the C code level.
5614 (defun keyboard-quit ()
5615 "Signal a `quit' condition.
5616 During execution of Lisp code, this character causes a quit directly.
5617 At top-level, as an editor command, this simply beeps."
5618 (interactive)
5619 ;; Avoid adding the region to the window selection.
5620 (setq saved-region-selection nil)
5621 (let (select-active-regions)
5622 (deactivate-mark))
5623 (if (fboundp 'kmacro-keyboard-quit)
5624 (kmacro-keyboard-quit))
5625 (setq defining-kbd-macro nil)
5626 (let ((debug-on-quit nil))
5627 (signal 'quit nil)))
5629 (defvar buffer-quit-function nil
5632 \(such as cancelling a prefix argument, minibuffer or region) do not apply.")
5634 (defun keyboard-escape-quit ()
5636 This command can exit an interactive command such as `query-replace',
5637 can clear out a prefix argument or a region,
5638 can get out of the minibuffer or other recursive edit,
5639 cancel the use of the current buffer (for special-purpose buffers),
5640 or go back to just one window (by deleting all but the selected window)."
5641 (interactive)
5642 (cond ((eq last-command 'mode-exited) nil)
5643 ((region-active-p)
5644 (deactivate-mark))
5645 ((> (minibuffer-depth) 0)
5646 (abort-recursive-edit))
5647 (current-prefix-arg
5648 nil)
5649 ((> (recursion-depth) 0)
5650 (exit-recursive-edit))
5651 (buffer-quit-function
5652 (funcall buffer-quit-function))
5653 ((not (one-window-p t))
5654 (delete-other-windows))
5656 (bury-buffer))))
5658 (defun play-sound-file (file &optional volume device)
5659 "Play sound stored in FILE.
5660 VOLUME and DEVICE correspond to the keywords of the sound
5661 specification for `play-sound'."
5662 (interactive "fPlay sound file: ")
5663 (let ((sound (list :file file)))
5664 (if volume
5665 (plist-put sound :volume volume))
5666 (if device
5667 (plist-put sound :device device))
5668 (push 'sound sound)
5669 (play-sound sound)))
5671 \f
5672 (defcustom read-mail-command 'rmail
5673 "Your preference for a mail reading package.
5674 This is used by some keybindings which support reading mail.
5675 See also `mail-user-agent' concerning sending mail."
5678 (function-item :tag "Emacs interface to MH"
5680 (function :tag "Other"))
5681 :version "21.1"
5682 :group 'mail)
5684 (defcustom mail-user-agent 'message-user-agent
5685 "Your preference for a mail composition package.
5686 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
5687 outgoing email message. This variable lets you specify which
5688 mail-sending package you prefer.
5690 Valid values include:
5692 `message-user-agent' -- use the Message package.
5693 See Info node `(message)'.
5694 `sendmail-user-agent' -- use the Mail package.
5695 See Info node `(emacs)Sending Mail'.
5696 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
5697 See Info node `(mh-e)'.
5698 `gnus-user-agent' -- like `message-user-agent', but with Gnus
5699 paraphernalia, particularly the Gcc: header for
5700 archiving.
5702 Additional valid symbols may be available; check with the author of
5703 your package for details. The function should return non-nil if it
5704 succeeds.
5706 See also `read-mail-command' concerning reading mail."
5707 :type '(radio (function-item :tag "Message package"
5709 message-user-agent)
5710 (function-item :tag "Mail package"
5712 sendmail-user-agent)
5713 (function-item :tag "Emacs interface to MH"
5715 mh-e-user-agent)
5716 (function-item :tag "Message with full Gnus features"
5718 gnus-user-agent)
5719 (function :tag "Other"))
5720 :version "23.2" ; sendmail->message
5721 :group 'mail)
5723 (defcustom compose-mail-user-agent-warnings t
5724 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
5725 If the value of `mail-user-agent' is the default, and the user
5726 appears to have customizations applying to the old default,
5727 `compose-mail' issues a warning."
5728 :type 'boolean
5729 :version "23.2"
5730 :group 'mail)
5732 (defun rfc822-goto-eoh ()
5733 "If the buffer starts with a mail header, move point to the header's end.
5734 Otherwise, moves to `point-min'.
5735 The end of the header is the start of the next line, if there is one,
5736 else the end of the last line. This function obeys RFC822."
5737 (goto-char (point-min))
5738 (when (re-search-forward
5740 (goto-char (match-beginning 0))))
5742 ;; Used by Rmail (e.g., rmail-forward).
5743 (defvar mail-encode-mml nil
5744 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
5745 the outgoing message before sending it.")
5747 (defun compose-mail (&optional to subject other-headers continue
5748 switch-function yank-action send-actions
5749 return-action)
5750 "Start composing a mail message to send.
5751 This uses the user's chosen mail composition package
5752 as selected with the variable `mail-user-agent'.
5753 The optional arguments TO and SUBJECT specify recipients
5754 and the initial Subject field, respectively.
5756 OTHER-HEADERS is an alist specifying additional
5757 header fields. Elements look like (HEADER . VALUE) where both
5758 HEADER and VALUE are strings.
5760 CONTINUE, if non-nil, says to continue editing a message already
5761 being composed. Interactively, CONTINUE is the prefix argument.
5763 SWITCH-FUNCTION, if non-nil, is a function to use to
5764 switch to and display the buffer used for mail composition.
5766 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
5767 to insert the raw text of the message being replied to.
5768 It has the form (FUNCTION . ARGS). The user agent will apply
5769 FUNCTION to ARGS, to insert the raw text of the original message.
5770 \(The user agent will also run `mail-citation-hook', *after* the
5771 original text has been inserted in this way.)
5773 SEND-ACTIONS is a list of actions to call when the message is sent.
5774 Each action has the form (FUNCTION . ARGS).
5776 RETURN-ACTION, if non-nil, is an action for returning to the
5777 caller. It has the form (FUNCTION . ARGS). The function is
5778 called after the mail has been sent or put aside, and the mail
5779 buffer buried."
5780 (interactive
5781 (list nil nil nil current-prefix-arg))
5783 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
5784 ;; from sendmail-user-agent to message-user-agent. Some users may
5785 ;; encounter incompatibilities. This hack tries to detect problems
5786 ;; and warn about them.
5787 (and compose-mail-user-agent-warnings
5788 (eq mail-user-agent 'message-user-agent)
5789 (let (warn-vars)
5790 (dolist (var '(mail-mode-hook mail-send-hook mail-setup-hook
5791 mail-yank-hooks mail-archive-file-name
5792 mail-default-reply-to mail-mailing-lists
5793 mail-self-blind))
5794 (and (boundp var)
5795 (symbol-value var)
5796 (push var warn-vars)))
5797 (when warn-vars
5798 (display-warning 'mail
5799 (format "\
5800 The default mail mode is now Message mode.
5801 You have the following Mail mode variable%s customized:
5803 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
5804 (if (> (length warn-vars) 1) "s" "")
5805 (mapconcat 'symbol-name
5806 warn-vars " "))))))
5808 (let ((function (get mail-user-agent 'composefunc)))
5809 (funcall function to subject other-headers continue switch-function
5810 yank-action send-actions return-action)))
5812 (defun compose-mail-other-window (&optional to subject other-headers continue
5813 yank-action send-actions
5814 return-action)
5816 (interactive (list nil nil nil current-prefix-arg))
5817 (compose-mail to subject other-headers continue
5818 'switch-to-buffer-other-window yank-action send-actions
5819 return-action))
5821 (defun compose-mail-other-frame (&optional to subject other-headers continue
5822 yank-action send-actions
5823 return-action)
5825 (interactive (list nil nil nil current-prefix-arg))
5826 (compose-mail to subject other-headers continue
5827 'switch-to-buffer-other-frame yank-action send-actions
5828 return-action))
5830 \f
5831 (defvar set-variable-value-history nil
5832 "History of values entered with `set-variable'.
5834 Maximum length of the history list is determined by the value
5835 of `history-length', which see.")
5837 (defun set-variable (variable value &optional make-local)
5838 "Set VARIABLE to VALUE. VALUE is a Lisp object.
5839 VARIABLE should be a user option variable name, a Lisp variable
5840 meant to be customized by users. You should enter VALUE in Lisp syntax,
5841 so if you want VALUE to be a string, you must surround it with doublequotes.
5842 VALUE is used literally, not evaluated.
5844 If VARIABLE has a `variable-interactive' property, that is used as if
5845 it were the arg to `interactive' (which see) to interactively read VALUE.
5847 If VARIABLE has been defined with `defcustom', then the type information
5848 in the definition is used to check that VALUE is valid.
5850 With a prefix argument, set VARIABLE to VALUE buffer-locally."
5851 (interactive
5852 (let* ((default-var (variable-at-point))
5853 (var (if (user-variable-p default-var)
5854 (read-variable (format "Set variable (default %s): " default-var)
5855 default-var)
5856 (read-variable "Set variable: ")))
5857 (minibuffer-help-form '(describe-variable var))
5858 (prop (get var 'variable-interactive))
5859 (obsolete (car (get var 'byte-obsolete-variable)))
5860 (prompt (format "Set %s %s to value: " var
5861 (cond ((local-variable-p var)
5862 "(buffer-local)")
5863 ((or current-prefix-arg
5864 (local-variable-if-set-p var))
5865 "buffer-locally")
5866 (t "globally"))))
5867 (val (progn
5868 (when obsolete
5869 (message (concat "`%S' is obsolete; "
5870 (if (symbolp obsolete) "use `%S' instead" "%s"))
5871 var obsolete)
5872 (sit-for 3))
5873 (if prop
5874 ;; Use VAR's `variable-interactive' property
5875 ;; as an interactive spec for prompting.
5876 (call-interactively `(lambda (arg)
5877 (interactive ,prop)
5878 arg))
5879 (read
5880 (read-string prompt nil
5881 'set-variable-value-history
5882 (format "%S" (symbol-value var))))))))
5883 (list var val current-prefix-arg)))
5885 (and (custom-variable-p variable)
5886 (not (get variable 'custom-type))
5887 (custom-load-symbol variable))
5888 (let ((type (get variable 'custom-type)))
5889 (when type
5890 ;; Match with custom type.
5891 (require 'cus-edit)
5892 (setq type (widget-convert type))
5893 (unless (widget-apply type :match value)
5894 (error "Value `%S' does not match type %S of %S"
5895 value (car type) variable))))
5897 (if make-local
5898 (make-local-variable variable))
5900 (set variable value)
5902 ;; Force a thorough redisplay for the case that the variable
5903 ;; has an effect on the display, like `tab-width' has.
5904 (force-mode-line-update))
5905 \f
5906 ;; Define the major mode for lists of completions.
5908 (defvar completion-list-mode-map
5909 (let ((map (make-sparse-keymap)))
5910 (define-key map [mouse-2] 'mouse-choose-completion)
5911 (define-key map [follow-link] 'mouse-face)
5912 (define-key map [down-mouse-2] nil)
5913 (define-key map "\C-m" 'choose-completion)
5914 (define-key map "\e\e\e" 'delete-completion-window)
5915 (define-key map [left] 'previous-completion)
5916 (define-key map [right] 'next-completion)
5917 (define-key map "q" 'quit-window)
5918 (define-key map "z" 'kill-this-buffer)
5919 map)
5920 "Local map for completion list buffers.")
5922 ;; Completion mode is suitable only for specially formatted data.
5923 (put 'completion-list-mode 'mode-class 'special)
5925 (defvar completion-reference-buffer nil
5926 "Record the buffer that was current when the completion list was requested.
5927 This is a local variable in the completion list buffer.
5928 Initial value is nil to avoid some compiler warnings.")
5930 (defvar completion-no-auto-exit nil
5931 "Non-nil means `choose-completion-string' should never exit the minibuffer.
5932 This also applies to other functions such as `choose-completion'.")
5934 (defvar completion-base-position nil
5935 "Position of the base of the text corresponding to the shown completions.
5936 This variable is used in the *Completions* buffers.
5937 Its value is a list of the form (START END) where START is the place
5938 where the completion should be inserted and END (if non-nil) is the end
5939 of the text to replace. If END is nil, point is used instead.")
5941 (defvar completion-list-insert-choice-function #'completion--replace
5942 "Function to use to insert the text chosen in *Completions*.
5943 Called with 3 arguments (BEG END TEXT), it should replace the text
5944 between BEG and END with TEXT. Expected to be set buffer-locally
5945 in the *Completions* buffer.")
5947 (defvar completion-base-size nil
5948 "Number of chars before point not involved in completion.
5949 This is a local variable in the completion list buffer.
5950 It refers to the chars in the minibuffer if completing in the
5951 minibuffer, or in `completion-reference-buffer' otherwise.
5952 Only characters in the field at point are included.
5954 If nil, Emacs determines which part of the tail end of the
5955 buffer's text is involved in completion by comparing the text
5956 directly.")
5957 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
5959 (defun delete-completion-window ()
5960 "Delete the completion list window.
5961 Go to the window from which completion was requested."
5962 (interactive)
5963 (let ((buf completion-reference-buffer))
5964 (if (one-window-p t)
5965 (if (window-dedicated-p (selected-window))
5966 (delete-frame (selected-frame)))
5967 (delete-window (selected-window))
5968 (if (get-buffer-window buf)
5969 (select-window (get-buffer-window buf))))))
5971 (defun previous-completion (n)
5972 "Move to the previous item in the completion list."
5973 (interactive "p")
5974 (next-completion (- n)))
5976 (defun next-completion (n)
5977 "Move to the next item in the completion list.
5978 With prefix argument N, move N items (negative N means move backward)."
5979 (interactive "p")
5980 (let ((beg (point-min)) (end (point-max)))
5981 (while (and (> n 0) (not (eobp)))
5982 ;; If in a completion, move to the end of it.
5983 (when (get-text-property (point) 'mouse-face)
5984 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
5985 ;; Move to start of next one.
5986 (unless (get-text-property (point) 'mouse-face)
5987 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
5988 (setq n (1- n)))
5989 (while (and (< n 0) (not (bobp)))
5990 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
5991 ;; If in a completion, move to the start of it.
5992 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
5993 (goto-char (previous-single-property-change
5994 (point) 'mouse-face nil beg)))
5995 ;; Move to end of the previous completion.
5996 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
5997 (goto-char (previous-single-property-change
5998 (point) 'mouse-face nil beg)))
5999 ;; Move to the start of that one.
6000 (goto-char (previous-single-property-change
6001 (point) 'mouse-face nil beg))
6002 (setq n (1+ n))))))
6004 (defun choose-completion (&optional event)
6005 "Choose the completion at point."
6006 (interactive (list last-nonmenu-event))
6007 ;; In case this is run via the mouse, give temporary modes such as
6008 ;; isearch a chance to turn off.
6009 (run-hooks 'mouse-leave-buffer-hook)
6010 (with-current-buffer (window-buffer (posn-window (event-start event)))
6011 (let ((buffer completion-reference-buffer)
6012 (base-size completion-base-size)
6013 (base-position completion-base-position)
6014 (insert-function completion-list-insert-choice-function)
6015 (choice
6016 (save-excursion
6017 (goto-char (posn-point (event-start event)))
6018 (let (beg end)
6019 (cond
6020 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
6021 (setq end (point) beg (1+ (point))))
6022 ((and (not (bobp))
6023 (get-text-property (1- (point)) 'mouse-face))
6024 (setq end (1- (point)) beg (point)))
6025 (t (error "No completion here")))
6026 (setq beg (previous-single-property-change beg 'mouse-face))
6027 (setq end (or (next-single-property-change end 'mouse-face)
6028 (point-max)))
6029 (buffer-substring-no-properties beg end))))
6030 (owindow (selected-window)))
6032 (unless (buffer-live-p buffer)
6033 (error "Destination buffer is dead"))
6034 (select-window (posn-window (event-start event)))
6035 (if (and (one-window-p t 'selected-frame)
6036 (window-dedicated-p (selected-window)))
6037 ;; This is a special buffer's frame
6038 (iconify-frame (selected-frame))
6039 (or (window-dedicated-p (selected-window))
6040 (bury-buffer)))
6041 (select-window
6042 (or (get-buffer-window buffer 0)
6043 owindow))
6045 (with-current-buffer buffer
6046 (choose-completion-string
6047 choice buffer
6048 (or base-position
6049 (when base-size
6050 ;; Someone's using old completion code that doesn't know
6051 ;; about base-position yet.
6052 (list (+ base-size (field-beginning))))
6053 ;; If all else fails, just guess.
6054 (list (choose-completion-guess-base-position choice)))
6055 insert-function)))))
6057 ;; Delete the longest partial match for STRING
6058 ;; that can be found before POINT.
6059 (defun choose-completion-guess-base-position (string)
6060 (save-excursion
6061 (let ((opoint (point))
6062 len)
6063 ;; Try moving back by the length of the string.
6064 (goto-char (max (- (point) (length string))
6065 (minibuffer-prompt-end)))
6066 ;; See how far back we were actually able to move. That is the
6067 ;; upper bound on how much we can match and delete.
6068 (setq len (- opoint (point)))
6069 (if completion-ignore-case
6070 (setq string (downcase string)))
6071 (while (and (> len 0)
6072 (let ((tail (buffer-substring (point) opoint)))
6073 (if completion-ignore-case
6074 (setq tail (downcase tail)))
6075 (not (string= tail (substring string 0 len)))))
6076 (setq len (1- len))
6077 (forward-char 1))
6078 (point))))
6080 (defun choose-completion-delete-max-match (string)
6081 (delete-region (choose-completion-guess-base-position string) (point)))
6082 (make-obsolete 'choose-completion-delete-max-match
6083 'choose-completion-guess-base-position "23.2")
6085 (defvar choose-completion-string-functions nil
6086 "Functions that may override the normal insertion of a completion choice.
6087 These functions are called in order with four arguments:
6088 CHOICE - the string to insert in the buffer,
6089 BUFFER - the buffer in which the choice should be inserted,
6090 MINI-P - non-nil if BUFFER is a minibuffer, and
6091 BASE-SIZE - the number of characters in BUFFER before
6092 the string being completed.
6094 If a function in the list returns non-nil, that function is supposed
6095 to have inserted the CHOICE in the BUFFER, and possibly exited
6096 the minibuffer; no further functions will be called.
6098 If all functions in the list return nil, that means to use
6099 the default method of inserting the completion in BUFFER.")
6101 (defun choose-completion-string (choice &optional
6102 buffer base-position insert-function)
6103 "Switch to BUFFER and insert the completion choice CHOICE.
6104 BASE-POSITION, says where to insert the completion."
6106 ;; If BUFFER is the minibuffer, exit the minibuffer
6107 ;; unless it is reading a file name and CHOICE is a directory,
6108 ;; or completion-no-auto-exit is non-nil.
6110 ;; Some older code may call us passing `base-size' instead of
6111 ;; `base-position'. It's difficult to make any use of `base-size',
6112 ;; so we just ignore it.
6113 (unless (consp base-position)
6114 (message "Obsolete `base-size' passed to choose-completion-string")
6115 (setq base-position nil))
6117 (let* ((buffer (or buffer completion-reference-buffer))
6118 (mini-p (minibufferp buffer)))
6119 ;; If BUFFER is a minibuffer, barf unless it's the currently
6120 ;; active minibuffer.
6121 (if (and mini-p
6122 (not (and (active-minibuffer-window)
6123 (equal buffer
6124 (window-buffer (active-minibuffer-window))))))
6125 (error "Minibuffer is not active for completion")
6126 ;; Set buffer so buffer-local choose-completion-string-functions works.
6127 (set-buffer buffer)
6128 (unless (run-hook-with-args-until-success
6129 'choose-completion-string-functions
6130 ;; The fourth arg used to be `mini-p' but was useless
6131 ;; (since minibufferp can be used on the `buffer' arg)
6132 ;; and indeed unused. The last used to be `base-size', so we
6133 ;; keep it to try and avoid breaking old code.
6134 choice buffer base-position nil)
6135 ;; This remove-text-properties should be unnecessary since `choice'
6136 ;; comes from buffer-substring-no-properties.
6137 ;;(remove-text-properties 0 (lenth choice) '(mouse-face nil) choice)
6138 ;; Insert the completion into the buffer where it was requested.
6139 (funcall (or insert-function completion-list-insert-choice-function)
6140 (or (car base-position) (point))
6141 (or (cadr base-position) (point))
6142 choice)
6143 ;; Update point in the window that BUFFER is showing in.
6144 (let ((window (get-buffer-window buffer t)))
6145 (set-window-point window (point)))
6146 ;; If completing for the minibuffer, exit it with this choice.
6147 (and (not completion-no-auto-exit)
6148 (minibufferp buffer)
6149 minibuffer-completion-table
6150 ;; If this is reading a file name, and the file name chosen
6151 ;; is a directory, don't exit the minibuffer.
6152 (let* ((result (buffer-substring (field-beginning) (point)))
6153 (bounds
6154 (completion-boundaries result minibuffer-completion-table
6155 minibuffer-completion-predicate
6156 "")))
6157 (if (eq (car bounds) (length result))
6158 ;; The completion chosen leads to a new set of completions
6159 ;; (e.g. it's a directory): don't exit the minibuffer yet.
6160 (let ((mini (active-minibuffer-window)))
6161 (select-window mini)
6162 (when minibuffer-auto-raise
6163 (raise-frame (window-frame mini))))
6164 (exit-minibuffer))))))))
6166 (define-derived-mode completion-list-mode nil "Completion List"
6167 "Major mode for buffers showing lists of possible completions.
6169 to select the completion near point.
6171 with the mouse.
6174 (set (make-local-variable 'completion-base-size) nil))
6176 (defun completion-list-mode-finish ()
6177 "Finish setup of the completions buffer.
6178 Called from `temp-buffer-show-hook'."
6179 (when (eq major-mode 'completion-list-mode)
6180 (toggle-read-only 1)))
6182 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
6185 ;; Variables and faces used in `completion-setup-function'.
6187 (defcustom completion-show-help t
6188 "Non-nil means show help message in *Completions* buffer."
6189 :type 'boolean
6190 :version "22.1"
6191 :group 'completion)
6193 ;; This function goes in completion-setup-hook, so that it is called
6194 ;; after the text of the completion list buffer is written.
6195 (defun completion-setup-function ()
6196 (let* ((mainbuf (current-buffer))
6197 (base-dir
6198 ;; When reading a file name in the minibuffer,
6199 ;; try and find the right default-directory to set in the
6200 ;; completion list buffer.
6201 ;; FIXME: Why do we do that, actually? --Stef
6202 (if minibuffer-completing-file-name
6203 (file-name-as-directory
6204 (expand-file-name
6205 (substring (minibuffer-completion-contents)
6206 0 (or completion-base-size 0)))))))
6207 (with-current-buffer standard-output
6208 (let ((base-size completion-base-size) ;Read before killing localvars.
6209 (base-position completion-base-position)
6210 (insert-fun completion-list-insert-choice-function))
6211 (completion-list-mode)
6212 (set (make-local-variable 'completion-base-size) base-size)
6213 (set (make-local-variable 'completion-base-position) base-position)
6214 (set (make-local-variable 'completion-list-insert-choice-function)
6215 insert-fun))
6216 (set (make-local-variable 'completion-reference-buffer) mainbuf)
6217 (if base-dir (setq default-directory base-dir))
6218 ;; Maybe insert help string.
6219 (when completion-show-help
6220 (goto-char (point-min))
6221 (if (display-mouse-p)
6222 (insert (substitute-command-keys
6224 (insert (substitute-command-keys
6228 (add-hook 'completion-setup-hook 'completion-setup-function)
6230 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
6231 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
6233 (defun switch-to-completions ()
6234 "Select the completion list window."
6235 (interactive)
6236 (let ((window (or (get-buffer-window "*Completions*" 0)
6237 ;; Make sure we have a completions window.
6238 (progn (minibuffer-completion-help)
6239 (get-buffer-window "*Completions*" 0)))))
6240 (when window
6241 (select-window window)
6242 ;; In the new buffer, go to the first completion.
6243 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
6244 (when (bobp)
6245 (next-completion 1)))))
6246 \f
6247 ;;; Support keyboard commands to turn on various modifiers.
6249 ;; These functions -- which are not commands -- each add one modifier
6250 ;; to the following event.
6252 (defun event-apply-alt-modifier (_ignore-prompt)
6255 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
6256 (defun event-apply-super-modifier (_ignore-prompt)
6259 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
6260 (defun event-apply-hyper-modifier (_ignore-prompt)
6263 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
6264 (defun event-apply-shift-modifier (_ignore-prompt)
6267 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
6268 (defun event-apply-control-modifier (_ignore-prompt)
6271 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
6272 (defun event-apply-meta-modifier (_ignore-prompt)
6275 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
6277 (defun event-apply-modifier (event symbol lshiftby prefix)
6278 "Apply a modifier flag to event EVENT.
6279 SYMBOL is the name of this modifier, as a symbol.
6280 LSHIFTBY is the numeric value of this modifier, in keyboard events.
6281 PREFIX is the string that represents this modifier in an event type symbol."
6282 (if (numberp event)
6283 (cond ((eq symbol 'control)
6284 (if (and (<= (downcase event) ?z)
6285 (>= (downcase event) ?a))
6286 (- (downcase event) ?a -1)
6287 (if (and (<= (downcase event) ?Z)
6288 (>= (downcase event) ?A))
6289 (- (downcase event) ?A -1)
6290 (logior (lsh 1 lshiftby) event))))
6291 ((eq symbol 'shift)
6292 (if (and (<= (downcase event) ?z)
6293 (>= (downcase event) ?a))
6294 (upcase event)
6295 (logior (lsh 1 lshiftby) event)))
6296 (t
6297 (logior (lsh 1 lshiftby) event)))
6298 (if (memq symbol (event-modifiers event))
6299 event
6300 (let ((event-type (if (symbolp event) event (car event))))
6301 (setq event-type (intern (concat prefix (symbol-name event-type))))
6302 (if (symbolp event)
6303 event-type
6304 (cons event-type (cdr event)))))))
6306 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
6307 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
6308 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
6309 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
6310 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
6311 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
6312 \f
6313 ;;;; Keypad support.
6315 ;; Make the keypad keys act like ordinary typing keys. If people add
6316 ;; bindings for the function key symbols, then those bindings will
6317 ;; override these, so this shouldn't interfere with any existing
6318 ;; bindings.
6320 ;; Also tell read-char how to handle these keys.
6321 (mapc
6322 (lambda (keypad-normal)
6323 (let ((keypad (nth 0 keypad-normal))
6324 (normal (nth 1 keypad-normal)))
6325 (put keypad 'ascii-character normal)
6326 (define-key function-key-map (vector keypad) (vector normal))))
6327 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
6328 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
6329 (kp-space ?\s)
6332 (kp-multiply ?*)
6333 (kp-add ?+)
6334 (kp-separator ?,)
6335 (kp-subtract ?-)
6336 (kp-decimal ?.)
6337 (kp-divide ?/)
6338 (kp-equal ?=)
6339 ;; Do the same for various keys that are represented as symbols under
6340 ;; GUIs but naturally correspond to characters.
6341 (backspace 127)
6342 (delete 127)
6345 (clear ?\C-l)
6346 (return ?\C-m)
6347 (escape ?\e)
6348 ))
6349 \f
6350 ;;;;
6351 ;;;; forking a twin copy of a buffer.
6352 ;;;;
6354 (defvar clone-buffer-hook nil
6355 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
6357 (defvar clone-indirect-buffer-hook nil
6358 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
6360 (defun clone-process (process &optional newname)
6361 "Create a twin copy of PROCESS.
6362 If NEWNAME is nil, it defaults to PROCESS' name;
6363 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
6364 If PROCESS is associated with a buffer, the new process will be associated
6365 with the current buffer instead.
6366 Returns nil if PROCESS has already terminated."
6367 (setq newname (or newname (process-name process)))
6369 (setq newname (substring newname 0 (match-beginning 0))))
6370 (when (memq (process-status process) '(run stop open))
6371 (let* ((process-connection-type (process-tty-name process))
6372 (new-process
6373 (if (memq (process-status process) '(open))
6374 (let ((args (process-contact process t)))
6375 (setq args (plist-put args :name newname))
6376 (setq args (plist-put args :buffer
6377 (if (process-buffer process)
6378 (current-buffer))))
6379 (apply 'make-network-process args))
6380 (apply 'start-process newname
6381 (if (process-buffer process) (current-buffer))
6382 (process-command process)))))
6383 (set-process-query-on-exit-flag
6384 new-process (process-query-on-exit-flag process))
6385 (set-process-inherit-coding-system-flag
6386 new-process (process-inherit-coding-system-flag process))
6387 (set-process-filter new-process (process-filter process))
6388 (set-process-sentinel new-process (process-sentinel process))
6389 (set-process-plist new-process (copy-sequence (process-plist process)))
6390 new-process)))
6392 ;; things to maybe add (currently partly covered by `funcall mode'):
6393 ;; - syntax-table
6394 ;; - overlays
6395 (defun clone-buffer (&optional newname display-flag)
6396 "Create and return a twin copy of the current buffer.
6397 Unlike an indirect buffer, the new buffer can be edited
6398 independently of the old one (if it is not read-only).
6399 NEWNAME is the name of the new buffer. It may be modified by
6400 adding or incrementing <N> at the end as necessary to create a
6401 unique buffer name. If nil, it defaults to the name of the
6402 current buffer, with the proper suffix. If DISPLAY-FLAG is
6403 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
6404 clone a file-visiting buffer, or a buffer whose major mode symbol
6405 has a non-nil `no-clone' property, results in an error.
6407 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
6408 current buffer with appropriate suffix. However, if a prefix
6409 argument is given, then the command prompts for NEWNAME in the
6410 minibuffer.
6412 This runs the normal hook `clone-buffer-hook' in the new buffer
6413 after it has been set up properly in other respects."
6414 (interactive
6415 (progn
6416 (if buffer-file-name
6417 (error "Cannot clone a file-visiting buffer"))
6418 (if (get major-mode 'no-clone)
6419 (error "Cannot clone a buffer in %s mode" mode-name))
6420 (list (if current-prefix-arg
6421 (read-buffer "Name of new cloned buffer: " (current-buffer)))
6422 t)))
6423 (if buffer-file-name
6424 (error "Cannot clone a file-visiting buffer"))
6425 (if (get major-mode 'no-clone)
6426 (error "Cannot clone a buffer in %s mode" mode-name))
6427 (setq newname (or newname (buffer-name)))
6429 (setq newname (substring newname 0 (match-beginning 0))))
6430 (let ((buf (current-buffer))
6431 (ptmin (point-min))
6432 (ptmax (point-max))
6433 (pt (point))
6434 (mk (if mark-active (mark t)))
6435 (modified (buffer-modified-p))
6436 (mode major-mode)
6437 (lvars (buffer-local-variables))
6438 (process (get-buffer-process (current-buffer)))
6439 (new (generate-new-buffer (or newname (buffer-name)))))
6440 (save-restriction
6441 (widen)
6442 (with-current-buffer new
6443 (insert-buffer-substring buf)))
6444 (with-current-buffer new
6445 (narrow-to-region ptmin ptmax)
6446 (goto-char pt)
6447 (if mk (set-mark mk))
6448 (set-buffer-modified-p modified)
6450 ;; Clone the old buffer's process, if any.
6451 (when process (clone-process process))
6453 ;; Now set up the major mode.
6454 (funcall mode)
6456 ;; Set up other local variables.
6457 (mapc (lambda (v)
6458 (condition-case () ;in case var is read-only
6459 (if (symbolp v)
6460 (makunbound v)
6461 (set (make-local-variable (car v)) (cdr v)))
6462 (error nil)))
6463 lvars)
6465 ;; Run any hooks (typically set up by the major mode
6466 ;; for cloning to work properly).
6467 (run-hooks 'clone-buffer-hook))
6468 (if display-flag
6469 ;; Presumably the current buffer is shown in the selected frame, so
6470 ;; we want to display the clone elsewhere.
6471 (let ((same-window-regexps nil)
6472 (same-window-buffer-names))
6473 (pop-to-buffer new)))
6474 new))
6477 (defun clone-indirect-buffer (newname display-flag &optional norecord)
6478 "Create an indirect buffer that is a twin copy of the current buffer.
6480 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
6481 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
6482 or if not called with a prefix arg, NEWNAME defaults to the current
6483 buffer's name. The name is modified by adding a `<N>' suffix to it
6484 or by incrementing the N in an existing suffix. Trying to clone a
6485 buffer whose major mode symbol has a non-nil `no-clone-indirect'
6486 property results in an error.
6488 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
6489 This is always done when called interactively.
6491 Optional third arg NORECORD non-nil means do not put this buffer at the
6492 front of the list of recently selected ones."
6493 (interactive
6494 (progn
6495 (if (get major-mode 'no-clone-indirect)
6496 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6497 (list (if current-prefix-arg
6498 (read-buffer "Name of indirect buffer: " (current-buffer)))
6499 t)))
6500 (if (get major-mode 'no-clone-indirect)
6501 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6502 (setq newname (or newname (buffer-name)))
6504 (setq newname (substring newname 0 (match-beginning 0))))
6505 (let* ((name (generate-new-buffer-name newname))
6506 (buffer (make-indirect-buffer (current-buffer) name t)))
6507 (with-current-buffer buffer
6508 (run-hooks 'clone-indirect-buffer-hook))
6509 (when display-flag
6510 (pop-to-buffer buffer norecord))
6511 buffer))
6514 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
6515 "Like `clone-indirect-buffer' but display in another window."
6516 (interactive
6517 (progn
6518 (if (get major-mode 'no-clone-indirect)
6519 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6520 (list (if current-prefix-arg
6521 (read-buffer "Name of indirect buffer: " (current-buffer)))
6522 t)))
6523 (let ((pop-up-windows t))
6524 (clone-indirect-buffer newname display-flag norecord)))
6526 \f
6527 ;;; Handling of Backspace and Delete keys.
6529 (defcustom normal-erase-is-backspace 'maybe
6530 "Set the default behavior of the Delete and Backspace keys.
6532 If set to t, Delete key deletes forward and Backspace key deletes
6533 backward.
6535 If set to nil, both Delete and Backspace keys delete backward.
6537 If set to 'maybe (which is the default), Emacs automatically
6538 selects a behavior. On window systems, the behavior depends on
6539 the keyboard used. If the keyboard has both a Backspace key and
6540 a Delete key, and both are mapped to their usual meanings, the
6541 option's default value is set to t, so that Backspace can be used
6542 to delete backward, and Delete can be used to delete forward.
6544 If not running under a window system, customizing this option
6545 accomplishes a similar effect by mapping C-h, which is usually
6546 generated by the Backspace key, to DEL, and by mapping DEL to C-d
6547 via `keyboard-translate'. The former functionality of C-h is
6548 available on the F1 key. You should probably not use this
6549 setting if you don't have both Backspace, Delete and F1 keys.
6551 Setting this variable with setq doesn't take effect. Programmatically,
6552 call `normal-erase-is-backspace-mode' (which see) instead."
6553 :type '(choice (const :tag "Off" nil)
6554 (const :tag "Maybe" maybe)
6555 (other :tag "On" t))
6556 :group 'editing-basics
6557 :version "21.1"
6558 :set (lambda (symbol value)
6559 ;; The fboundp is because of a problem with :set when
6560 ;; dumping Emacs. It doesn't really matter.
6561 (if (fboundp 'normal-erase-is-backspace-mode)
6562 (normal-erase-is-backspace-mode (or value 0))
6563 (set-default symbol value))))
6565 (defun normal-erase-is-backspace-setup-frame (&optional frame)
6566 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
6567 (unless frame (setq frame (selected-frame)))
6568 (with-selected-frame frame
6569 (unless (terminal-parameter nil 'normal-erase-is-backspace)
6570 (normal-erase-is-backspace-mode
6571 (if (if (eq normal-erase-is-backspace 'maybe)
6572 (and (not noninteractive)
6573 (or (memq system-type '(ms-dos windows-nt))
6574 (memq window-system '(ns))
6575 (and (memq window-system '(x))
6576 (fboundp 'x-backspace-delete-keys-p)
6577 (x-backspace-delete-keys-p))
6578 ;; If the terminal Emacs is running on has erase char
6579 ;; set to ^H, use the Backspace key for deleting
6580 ;; backward, and the Delete key for deleting forward.
6581 (and (null window-system)
6582 (eq tty-erase-char ?\^H))))
6583 normal-erase-is-backspace)
6584 1 0)))))
6586 (define-minor-mode normal-erase-is-backspace-mode
6587 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
6589 With numeric ARG, turn the mode on if and only if ARG is positive.
6591 On window systems, when this mode is on, Delete is mapped to C-d
6592 and Backspace is mapped to DEL; when this mode is off, both
6593 Delete and Backspace are mapped to DEL. (The remapping goes via
6594 `local-function-key-map', so binding Delete or Backspace in the
6595 global or local keymap will override that.)
6597 In addition, on window systems, the bindings of C-Delete, M-Delete,
6598 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
6599 the global keymap in accordance with the functionality of Delete and
6600 Backspace. For example, if Delete is remapped to C-d, which deletes
6601 forward, C-Delete is bound to `kill-word', but if Delete is remapped
6602 to DEL, which deletes backward, C-Delete is bound to
6603 `backward-kill-word'.
6605 If not running on a window system, a similar effect is accomplished by
6606 remapping C-h (normally produced by the Backspace key) and DEL via
6607 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
6608 to C-d; if it's off, the keys are not remapped.
6610 When not running on a window system, and this mode is turned on, the
6611 former functionality of C-h is available on the F1 key. You should
6612 probably not turn on this mode on a text-only terminal if you don't
6613 have both Backspace, Delete and F1 keys.
6615 See also `normal-erase-is-backspace'."
6616 :variable (eq (terminal-parameter
6617 nil 'normal-erase-is-backspace) 1)
6618 (let ((enabled (eq 1 (terminal-parameter
6619 nil 'normal-erase-is-backspace))))
6621 (cond ((or (memq window-system '(x w32 ns pc))
6622 (memq system-type '(ms-dos windows-nt)))
6623 (let ((bindings
6624 `(([M-delete] [M-backspace])
6625 ([C-M-delete] [C-M-backspace])
6626 ([?\e C-delete] [?\e C-backspace]))))
6628 (if enabled
6629 (progn
6630 (define-key local-function-key-map [delete] [deletechar])
6631 (define-key local-function-key-map [kp-delete] [?\C-d])
6632 (define-key local-function-key-map [backspace] [?\C-?])
6633 (dolist (b bindings)
6634 ;; Not sure if input-decode-map is really right, but
6635 ;; keyboard-translate-table (used below) only works
6636 ;; for integer events, and key-translation-table is
6637 ;; global (like the global-map, used earlier).
6638 (define-key input-decode-map (car b) nil)
6639 (define-key input-decode-map (cadr b) nil)))
6640 (define-key local-function-key-map [delete] [?\C-?])
6641 (define-key local-function-key-map [kp-delete] [?\C-?])
6642 (define-key local-function-key-map [backspace] [?\C-?])
6643 (dolist (b bindings)
6644 (define-key input-decode-map (car b) (cadr b))
6645 (define-key input-decode-map (cadr b) (car b))))))
6646 (t
6647 (if enabled
6648 (progn
6649 (keyboard-translate ?\C-h ?\C-?)
6650 (keyboard-translate ?\C-? ?\C-d))
6651 (keyboard-translate ?\C-h ?\C-h)
6652 (keyboard-translate ?\C-? ?\C-?))))
6654 (if (called-interactively-p 'interactive)
6655 (message "Delete key deletes %s"
6656 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
6657 "forward" "backward")))))
6658 \f
6659 (defvar vis-mode-saved-buffer-invisibility-spec nil
6660 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
6662 (define-minor-mode visible-mode
6663 "Toggle Visible mode.
6664 With argument ARG turn Visible mode on if ARG is positive, otherwise
6665 turn it off.
6667 Enabling Visible mode makes all invisible text temporarily visible.
6668 Disabling Visible mode turns off that effect. Visible mode works by
6669 saving the value of `buffer-invisibility-spec' and setting it to nil."
6670 :lighter " Vis"
6671 :group 'editing-basics
6672 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
6673 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
6674 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
6675 (when visible-mode
6676 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
6677 buffer-invisibility-spec)
6678 (setq buffer-invisibility-spec nil)))
6679 \f
6680 ;; Minibuffer prompt stuff.
6682 ;;(defun minibuffer-prompt-modification (start end)
6683 ;; (error "You cannot modify the prompt"))
6684 ;;
6685 ;;
6686 ;;(defun minibuffer-prompt-insertion (start end)
6687 ;; (let ((inhibit-modification-hooks t))
6688 ;; (delete-region start end)
6689 ;; ;; Discard undo information for the text insertion itself
6690 ;; ;; and for the text deletion.above.
6691 ;; (when (consp buffer-undo-list)
6692 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
6693 ;; (message "You cannot modify the prompt")))
6694 ;;
6695 ;;
6696 ;;(setq minibuffer-prompt-properties
6697 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
6698 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
6700 \f
6701 ;;;; Problematic external packages.
6703 ;; rms says this should be done by specifying symbols that define
6704 ;; versions together with bad values. This is therefore not as
6705 ;; flexible as it could be. See the thread:
6706 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
6707 (defconst bad-packages-alist
6708 ;; Not sure exactly which semantic versions have problems.
6709 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
6711 "The version of `semantic' loaded does not work in Emacs 22.
6712 It can cause constant high CPU load.
6713 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
6714 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
6715 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
6716 ;; provided the `CUA-mode' feature. Since this is no longer true,
6717 ;; we can warn the user if the `CUA-mode' feature is ever provided.
6718 (CUA-mode t nil
6719 "CUA-mode is now part of the standard GNU Emacs distribution,
6720 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
6722 You have loaded an older version of CUA-mode which does not work
6723 correctly with this version of Emacs. You should remove the old
6724 version and use the one distributed with Emacs."))
6725 "Alist of packages known to cause problems in this version of Emacs.
6726 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
6727 PACKAGE is either a regular expression to match file names, or a
6728 symbol (a feature name); see the documentation of
6729 `after-load-alist', to which this variable adds functions.
6730 SYMBOL is either the name of a string variable, or `t'. Upon
6731 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
6732 warning using STRING as the message.")
6734 (defun bad-package-check (package)
6735 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
6736 (condition-case nil
6737 (let* ((list (assoc package bad-packages-alist))
6738 (symbol (nth 1 list)))
6739 (and list
6740 (boundp symbol)
6741 (or (eq symbol t)
6742 (and (stringp (setq symbol (eval symbol)))
6743 (string-match-p (nth 2 list) symbol)))
6744 (display-warning package (nth 3 list) :warning)))
6745 (error nil)))
6747 (mapc (lambda (elem)
6748 (eval-after-load (car elem) `(bad-package-check ',(car elem))))
6749 bad-packages-alist)
6752 (provide 'simple)
6754 ;;; simple.el ends here