1 ;;; cua-base.el --- emulate CUA key bindings
3 ;; Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007 Free Software Foundation, Inc.
6 ;; Author: Kim F. Storm <storm@cua.dk>
7 ;; Keywords: keyboard emulation convenience cua
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, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
29 ;; This is the CUA package which provides a complete emulation of the
30 ;; standard CUA key bindings (Motif/Windows/Mac GUI) for selecting and
31 ;; manipulating the region where S-<movement> is used to highlight &
34 ;; CUA style key bindings for cut and paste
35 ;; ----------------------------------------
37 ;; This package allows the C-z, C-x, C-c, and C-v keys to be
38 ;; bound appropriately according to the Motif/Windows GUI, i.e.
44 ;; The tricky part is the handling of the C-x and C-c keys which
45 ;; are normally used as prefix keys for most of emacs' built-in
46 ;; commands. With CUA they still do!!!
48 ;; Only when the region is currently active (and highlighted since
49 ;; transient-mark-mode is used), the C-x and C-c keys will work as CUA
53 ;; When the region is not active, C-x and C-c works as prefix keys!
55 ;; This probably sounds strange and difficult to get used to - but
56 ;; based on my own experience and the feedback from many users of
57 ;; this package, it actually works very well and users adapt to it
58 ;; instantly - or at least very quickly. So give it a try!
59 ;; ... and in the few cases where you make a mistake and accidentally
60 ;; delete the region - you just undo the mistake (with C-z).
62 ;; If you really need to perform a command which starts with one of
63 ;; the prefix keys even when the region is active, you have three options:
64 ;; - press the prefix key twice very quickly (within 0.2 seconds),
65 ;; - press the prefix key and the following key within 0.2 seconds, or
66 ;; - use the SHIFT key with the prefix key, i.e. C-X or C-C
68 ;; This behaviour can be customized via the
69 ;; cua-prefix-override-inhibit-delay variable.
71 ;; In addition to using the shifted movement keys, you can also use
72 ;; [C-space] to start the region and use unshifted movement keys to extend
73 ;; it. To cancel the region, use [C-space] or [C-g].
75 ;; If you prefer to use the standard emacs cut, copy, paste, and undo
76 ;; bindings, customize cua-enable-cua-keys to nil.
79 ;; Typing text replaces the region
80 ;; -------------------------------
82 ;; When the region is active, i.e. highlighted, the text in region is
83 ;; replaced by the text you type.
85 ;; The replaced text is saved in register 0 which can be inserted using
86 ;; the key sequence M-0 C-v (see the section on register support below).
88 ;; If you have just replaced a highlighted region with typed text,
89 ;; you can repeat the replace with M-v. This will search forward
90 ;; for a streach of text identical to the previous contents of the
91 ;; region (i.e. the contents of register 0) and replace it with the
92 ;; text you typed to replace the original region. Repeating M-v will
93 ;; replace the next matching region and so on.
95 ;; Example: Suppose you have a line like this
96 ;; The redo operation will redo the last redoable command
97 ;; which you want to change into
98 ;; The repeat operation will repeat the last repeatable command
99 ;; This is done by highlighting the first occurrence of "redo"
100 ;; and type "repeat" M-v M-v.
102 ;; Note: Since CUA-mode duplicates the functionality of the
103 ;; delete-selection-mode, that mode is automatically disabled when
104 ;; CUA-mode is enabled.
107 ;; CUA mode indications
108 ;; --------------------
109 ;; You can choose to let CUA use different cursor colors to indicate
110 ;; overwrite mode and read-only buffers. For example, the following
111 ;; setting will use a RED cursor in normal (insertion) mode in
112 ;; read-write buffers, a YELLOW cursor in overwrite mode in read-write
113 ;; buffers, and a GREEN cursor read-only buffers:
115 ;; (setq cua-normal-cursor-color "red")
116 ;; (setq cua-overwrite-cursor-color "yellow")
117 ;; (setq cua-read-only-cursor-color "green")
120 ;; CUA register support
121 ;; --------------------
122 ;; Emacs' standard register support is also based on a separate set of
123 ;; "register commands".
125 ;; CUA's register support is activated by providing a numeric
126 ;; prefix argument to the C-x, C-c, and C-v commands. For example,
127 ;; to copy the selected region to register 2, enter [M-2 C-c].
128 ;; Or if you have activated the keypad prefix mode, enter [kp-2 C-c].
130 ;; And CUA will copy and paste normal region as well as rectangles
131 ;; into the registers, i.e. you use exactly the same command for both.
133 ;; In addition, the last highlighted text that is deleted (not
134 ;; copied), e.g. by [delete] or by typing text over a highlighted
135 ;; region, is automatically saved in register 0, so you can insert it
138 ;; CUA rectangle support
139 ;; ---------------------
140 ;; Emacs' normal rectangle support is based on interpreting the region
141 ;; between the mark and point as a "virtual rectangle", and using a
142 ;; completely separate set of "rectangle commands" [C-x r ...] on the
143 ;; region to copy, kill, fill a.s.o. the virtual rectangle.
145 ;; cua-mode's superior rectangle support uses a true visual
146 ;; representation of the selected rectangle, i.e. it highlights the
147 ;; actual part of the buffer that is currently selected as part of the
148 ;; rectangle. Unlike emacs' traditional rectangle commands, the
149 ;; selected rectangle always as straight left and right edges, even
150 ;; when those are in the middle of a TAB character or beyond the end
151 ;; of the current line. And it does this without actually modifying
152 ;; the buffer contents (it uses display overlays to visualize the
153 ;; virtual dimensions of the rectangle).
155 ;; This means that cua-mode's rectangles are not limited to the actual
156 ;; contents of the buffer, so if the cursor is currently at the end of a
157 ;; short line, you can still extend the rectangle to include more columns
158 ;; of longer lines in the same rectangle. And you can also have the
159 ;; left edge of a rectangle start in the middle of a TAB character.
160 ;; Sounds strange? Try it!
162 ;; To start a rectangle, use [C-return] and extend it using the normal
163 ;; movement keys (up, down, left, right, home, end, C-home,
164 ;; C-end). Once the rectangle has the desired size, you can cut or
165 ;; copy it using C-x and C-c (or C-w and M-w), and you can
166 ;; subsequently insert it - as a rectangle - using C-v (or C-y). So
167 ;; the only new command you need to know to work with cua-mode
168 ;; rectangles is C-return!
170 ;; Normally, when you paste a rectangle using C-v (C-y), each line of
171 ;; the rectangle is inserted into the existing lines in the buffer.
172 ;; If overwrite-mode is active when you paste a rectangle, it is
173 ;; inserted as normal (multi-line) text.
175 ;; If you prefer the traditional rectangle marking (i.e. don't want
176 ;; straight edges), [M-p] toggles this for the current rectangle,
177 ;; or you can customize cua-virtual-rectangle-edges.
179 ;; And there's more: If you want to extend or reduce the size of the
180 ;; rectangle in one of the other corners of the rectangle, just use
181 ;; [return] to move the cursor to the "next" corner. Or you can use
182 ;; the [M-up], [M-down], [M-left], and [M-right] keys to move the
183 ;; entire rectangle overlay (but not the contents) in the given
186 ;; [C-return] cancels the rectangle
187 ;; [C-space] activates the region bounded by the rectangle
189 ;; If you type a normal (self-inserting) character when the rectangle is
190 ;; active, the character is inserted on the "current side" of every line
191 ;; of the rectangle. The "current side" is the side on which the cursor
192 ;; is currently located. If the rectangle is only 1 column wide,
193 ;; insertion will be performed to the left when the cursor is at the
194 ;; bottom of the rectangle. So, for example, to comment out an entire
195 ;; paragraph like this one, just place the cursor on the first character
196 ;; of the first line, and enter the following:
197 ;; C-return M-} ; ; <space> C-return
199 ;; cua-mode's rectangle support also includes all the normal rectangle
200 ;; functions with easy access:
202 ;; [M-a] aligns all words at the left edge of the rectangle
203 ;; [M-b] fills the rectangle with blanks (tabs and spaces)
204 ;; [M-c] closes the rectangle by removing all blanks at the left edge
206 ;; [M-f] fills the rectangle with a single character (prompt)
207 ;; [M-i] increases the first number found on each line of the rectangle
208 ;; by the amount given by the numeric prefix argument (default 1)
209 ;; It recognizes 0x... as hexadecimal numbers
210 ;; [M-k] kills the rectangle as normal multi-line text (for paste)
211 ;; [M-l] downcases the rectangle
212 ;; [M-m] copies the rectangle as normal multi-line text (for paste)
213 ;; [M-n] fills each line of the rectangle with increasing numbers using
214 ;; a supplied format string (prompt)
215 ;; [M-o] opens the rectangle by moving the highlighted text to the
216 ;; right of the rectangle and filling the rectangle with blanks.
217 ;; [M-p] toggles virtual straight rectangle edges
218 ;; [M-P] inserts tabs and spaces (padding) to make real straight edges
219 ;; [M-q] performs text filling on the rectangle
220 ;; [M-r] replaces REGEXP (prompt) by STRING (prompt) in rectangle
221 ;; [M-R] reverse the lines in the rectangle
222 ;; [M-s] fills each line of the rectangle with the same STRING (prompt)
223 ;; [M-t] performs text fill of the rectangle with TEXT (prompt)
224 ;; [M-u] upcases the rectangle
225 ;; [M-|] runs shell command on rectangle
226 ;; [M-'] restricts rectangle to lines with CHAR (prompt) at left column
227 ;; [M-/] restricts rectangle to lines matching REGEXP (prompt)
228 ;; [C-?] Shows a brief list of the above commands.
230 ;; [M-C-up] and [M-C-down] scrolls the lines INSIDE the rectangle up
231 ;; and down; lines scrolled outside the top or bottom of the rectangle
232 ;; are lost, but can be recovered using [C-z].
236 ;; The final feature provided by CUA is the "global mark", which
237 ;; makes it very easy to copy bits and pieces from the same and other
238 ;; files into the current text. To enable and cancel the global mark,
239 ;; use [S-C-space]. The cursor will blink when the global mark
240 ;; is active. The following commands behave differently when the global
242 ;; <ch> All characters (including newlines) you type are inserted
243 ;; at the global mark!
244 ;; [C-x] If you cut a region or rectangle, it is automatically inserted
245 ;; at the global mark, and the global mark is advanced.
246 ;; [C-c] If you copy a region or rectangle, it is immediately inserted
247 ;; at the global mark, and the global mark is advanced.
248 ;; [C-v] Copies a single character to the global mark.
249 ;; [C-d] Moves (i.e. deletes and inserts) a single character to the
251 ;; [backspace] deletes the character before the global mark, while
252 ;; [delete] deltes the character after the global mark.
254 ;; [S-C-space] Jumps to and cancels the global mark.
255 ;; [C-u S-C-space] Cancels the global mark (stays in current buffer).
257 ;; [TAB] Indents the current line or rectangle to the column of the
265 "Emulate CUA key bindings including C-x and C-c."
267 :group
'editing-basics
271 :link
'(emacs-commentary-link :tag
"Commentary" "cua-base.el")
272 :link
'(emacs-library-link :tag
"Lisp File" "cua-base.el"))
274 (defcustom cua-enable-cua-keys t
275 "*Enable using C-z, C-x, C-c, and C-v for undo, cut, copy, and paste.
276 If the value is t, these mappings are always enabled. If the value is
277 `shift', these keys are only enabled if the last region was marked with
278 a shifted movement key. If the value is nil, these keys are never
280 :type
'(choice (const :tag
"Disabled" nil
)
281 (const :tag
"Shift region only" shift
)
282 (other :tag
"Enabled" t
))
285 (defcustom cua-highlight-region-shift-only nil
286 "*If non-nil, only highlight region if marked with S-<move>.
287 When this is non-nil, CUA toggles `transient-mark-mode' on when the region
288 is marked using shifted movement keys, and off when the mark is cleared.
289 But when the mark was set using \\[cua-set-mark], transient-mark-mode
294 (defcustom cua-prefix-override-inhibit-delay
295 (if (featurep 'lisp-float-type
) (/ (float 1) (float 5)) nil
)
296 "*If non-nil, time in seconds to delay before overriding prefix key.
297 If there is additional input within this time, the prefix key is
298 used as a normal prefix key. So typing a key sequence quickly will
299 inhibit overriding the prefix key.
300 As a special case, if the prefix keys repeated within this time, the
301 first prefix key is discarded, so typing a prefix key twice in quick
302 succession will also inhibit overriding the prefix key.
303 If the value is nil, use a shifted prefix key to inhibit the override."
304 :type
'(choice (number :tag
"Inhibit delay")
305 (const :tag
"No delay" nil
))
308 (defcustom cua-delete-selection t
309 "*If non-nil, typed text replaces text in the active selection."
310 :type
'(choice (const :tag
"Disabled" nil
)
311 (other :tag
"Enabled" t
))
314 (defcustom cua-keep-region-after-copy nil
315 "If non-nil, don't deselect the region after copying."
319 (defcustom cua-toggle-set-mark t
320 "*If non-nil, the `cua-set-mark' command toggles the mark."
321 :type
'(choice (const :tag
"Disabled" nil
)
322 (other :tag
"Enabled" t
))
325 (defcustom cua-auto-mark-last-change nil
326 "*If non-nil, set implicit mark at position of last buffer change.
327 This means that \\[universal-argument] \\[cua-set-mark] will jump to the position
328 of the last buffer change before jumping to the explicit marks on the mark ring.
329 See `cua-set-mark' for details."
333 (defcustom cua-enable-register-prefix
'not-ctrl-u
334 "*If non-nil, registers are supported via numeric prefix arg.
335 If the value is t, any numeric prefix arg in the range 0 to 9 will be
336 interpreted as a register number.
337 If the value is `not-ctrl-u', using C-u to enter a numeric prefix is not
338 interpreted as a register number.
339 If the value is `ctrl-u-only', only numeric prefix entered with C-u is
340 interpreted as a register number."
341 :type
'(choice (const :tag
"Disabled" nil
)
342 (const :tag
"Enabled, but C-u arg is not a register" not-ctrl-u
)
343 (const :tag
"Enabled, but only for C-u arg" ctrl-u-only
)
344 (other :tag
"Enabled" t
))
347 (defcustom cua-delete-copy-to-register-0 t
348 "*If non-nil, save last deleted region or rectangle to register 0."
352 (defcustom cua-enable-region-auto-help nil
353 "*If non-nil, automatically show help for active region."
357 (defcustom cua-enable-modeline-indications nil
358 "*If non-nil, use minor-mode hook to show status in mode line."
362 (defcustom cua-check-pending-input t
363 "*If non-nil, don't override prefix key if input pending.
364 It is rumoured that `input-pending-p' is unreliable under some window
365 managers, so try setting this to nil, if prefix override doesn't work."
369 (defcustom cua-paste-pop-rotate-temporarily nil
370 "*If non-nil, \\[cua-paste-pop] only rotates the kill-ring temporarily.
371 This means that both \\[yank] and the first \\[yank-pop] in a sequence always insert
372 the most recently killed text. Each immediately following \\[cua-paste-pop] replaces
373 the previous text with the next older element on the `kill-ring'.
374 With prefix arg, \\[universal-argument] \\[yank-pop] inserts the same text as the most
375 recent \\[yank-pop] (or \\[yank]) command."
379 ;;; Rectangle Customization
381 (defcustom cua-virtual-rectangle-edges t
382 "*If non-nil, rectangles have virtual straight edges.
383 Note that although rectangles are always DISPLAYED with straight edges, the
384 buffer is NOT modified, until you execute a command that actually modifies it.
385 M-p toggles this feature when a rectangle is active."
389 (defcustom cua-auto-tabify-rectangles
1000
390 "*If non-nil, automatically tabify after rectangle commands.
391 This basically means that `tabify' is applied to all lines that
392 are modified by inserting or deleting a rectangle. If value is
393 an integer, CUA will look for existing tabs in a region around
394 the rectangle, and only do the conversion if any tabs are already
395 present. The number specifies then number of characters before
396 and after the region marked by the rectangle to search."
397 :type
'(choice (number :tag
"Auto detect (limit)")
398 (const :tag
"Disabled" nil
)
399 (other :tag
"Enabled" t
))
402 (defvar cua-global-keymap
) ; forward
403 (defvar cua--region-keymap
) ; forward
405 (defcustom cua-rectangle-mark-key
[(control return
)]
406 "Global key used to toggle the cua rectangle mark."
407 :set
#'(lambda (symbol value
)
409 (when (and (boundp 'cua--keymaps-initalized
)
410 cua--keymaps-initalized
)
411 (define-key cua-global-keymap value
412 'cua-set-rectangle-mark
)
413 (when (boundp 'cua--rectangle-keymap
)
414 (define-key cua--rectangle-keymap value
415 'cua-clear-rectangle-mark
)
416 (define-key cua--region-keymap value
417 'cua-toggle-rectangle-mark
))))
421 (defcustom cua-rectangle-modifier-key
'meta
422 "*Modifier key used for rectangle commands bindings.
423 On non-window systems, always use the meta modifier.
424 Must be set prior to enabling CUA."
425 :type
'(choice (const :tag
"Meta key" meta
)
426 (const :tag
"Alt key" alt
)
427 (const :tag
"Hyper key" hyper
)
428 (const :tag
"Super key" super
))
431 (defcustom cua-enable-rectangle-auto-help t
432 "*If non-nil, automatically show help for region, rectangle and global mark."
436 (defface cua-rectangle
437 '((default :inherit region
)
438 (((class color
)) :foreground
"white" :background
"maroon"))
439 "*Font used by CUA for highlighting the rectangle."
442 (defface cua-rectangle-noselect
443 '((default :inherit region
)
444 (((class color
)) :foreground
"white" :background
"dimgray"))
445 "*Font used by CUA for highlighting the non-selected rectangle lines."
449 ;;; Global Mark Customization
451 (defcustom cua-global-mark-keep-visible t
452 "*If non-nil, always keep global mark visible in other window."
456 (defface cua-global-mark
457 '((((min-colors 88)(class color
)) :foreground
"black" :background
"yellow1")
458 (((class color
)) :foreground
"black" :background
"yellow")
460 "*Font used by CUA for highlighting the global mark."
463 (defcustom cua-global-mark-blink-cursor-interval
0.20
464 "*Blink cursor at this interval when global mark is active."
465 :type
'(choice (number :tag
"Blink interval")
466 (const :tag
"No blink" nil
))
470 ;;; Cursor Indication Customization
472 (defcustom cua-enable-cursor-indications nil
473 "*If non-nil, use different cursor colors for indications."
477 (defcustom cua-normal-cursor-color
(or (and (boundp 'initial-cursor-color
) initial-cursor-color
)
478 (and (boundp 'initial-frame-alist
)
479 (assoc 'cursor-color initial-frame-alist
)
480 (cdr (assoc 'cursor-color initial-frame-alist
)))
481 (and (boundp 'default-frame-alist
)
482 (assoc 'cursor-color default-frame-alist
)
483 (cdr (assoc 'cursor-color default-frame-alist
)))
484 (frame-parameter nil
'cursor-color
)
486 "Normal (non-overwrite) cursor color.
487 Default is to load cursor color from initial or default frame parameters.
489 If the value is a COLOR name, then only the `cursor-color' attribute will be
490 affected. If the value is a cursor TYPE (one of: box, hollow, bar, or hbar),
491 then only the `cursor-type' property will be affected. If the value is
492 a cons (TYPE . COLOR), then both properties are affected."
493 :initialize
'custom-initialize-default
497 (const :tag
"Filled box" box
)
498 (const :tag
"Vertical bar" bar
)
499 (const :tag
"Horizontal bar" hbar
)
500 (const :tag
"Hollow box" hollow
))
501 (cons :tag
"Color and Type"
503 (const :tag
"Filled box" box
)
504 (const :tag
"Vertical bar" bar
)
505 (const :tag
"Horizontal bar" hbar
)
506 (const :tag
"Hollow box" hollow
))
507 (color :tag
"Color")))
510 (defcustom cua-read-only-cursor-color
"darkgreen"
511 "*Cursor color used in read-only buffers, if non-nil.
512 Only used when `cua-enable-cursor-indications' is non-nil.
514 If the value is a COLOR name, then only the `cursor-color' attribute will be
515 affected. If the value is a cursor TYPE (one of: box, hollow, bar, or hbar),
516 then only the `cursor-type' property will be affected. If the value is
517 a cons (TYPE . COLOR), then both properties are affected."
521 (const :tag
"Filled box" box
)
522 (const :tag
"Vertical bar" bar
)
523 (const :tag
"Horizontal bar" hbar
)
524 (const :tag
"Hollow box" hollow
))
525 (cons :tag
"Color and Type"
527 (const :tag
"Filled box" box
)
528 (const :tag
"Vertical bar" bar
)
529 (const :tag
"Horizontal bar" hbar
)
530 (const :tag
"Hollow box" hollow
))
531 (color :tag
"Color")))
534 (defcustom cua-overwrite-cursor-color
"yellow"
535 "*Cursor color used when overwrite mode is set, if non-nil.
536 Only used when `cua-enable-cursor-indications' is non-nil.
538 If the value is a COLOR name, then only the `cursor-color' attribute will be
539 affected. If the value is a cursor TYPE (one of: box, hollow, bar, or hbar),
540 then only the `cursor-type' property will be affected. If the value is
541 a cons (TYPE . COLOR), then both properties are affected."
545 (const :tag
"Filled box" box
)
546 (const :tag
"Vertical bar" bar
)
547 (const :tag
"Horizontal bar" hbar
)
548 (const :tag
"Hollow box" hollow
))
549 (cons :tag
"Color and Type"
551 (const :tag
"Filled box" box
)
552 (const :tag
"Vertical bar" bar
)
553 (const :tag
"Horizontal bar" hbar
)
554 (const :tag
"Hollow box" hollow
))
555 (color :tag
"Color")))
558 (defcustom cua-global-mark-cursor-color
"cyan"
559 "*Indication for active global mark.
560 Will change cursor color to specified color if string.
561 Only used when `cua-enable-cursor-indications' is non-nil.
563 If the value is a COLOR name, then only the `cursor-color' attribute will be
564 affected. If the value is a cursor TYPE (one of: box, hollow, bar, or hbar),
565 then only the `cursor-type' property will be affected. If the value is
566 a cons (TYPE . COLOR), then both properties are affected."
570 (const :tag
"Filled box" box
)
571 (const :tag
"Vertical bar" bar
)
572 (const :tag
"Horizontal bar" hbar
)
573 (const :tag
"Hollow box" hollow
))
574 (cons :tag
"Color and Type"
576 (const :tag
"Filled box" box
)
577 (const :tag
"Vertical bar" bar
)
578 (const :tag
"Horizontal bar" hbar
)
579 (const :tag
"Hollow box" hollow
))
580 (color :tag
"Color")))
584 ;;; Rectangle support is in cua-rect.el
586 (autoload 'cua-set-rectangle-mark
"cua-rect" nil t nil
)
588 ;; Stub definitions until it is loaded
590 (when (not (featurep 'cua-rect
))
591 (defvar cua--rectangle
)
592 (setq cua--rectangle nil
)
593 (defvar cua--last-killed-rectangle
)
594 (setq cua--last-killed-rectangle nil
))
598 ;;; Global Mark support is in cua-gmrk.el
600 (autoload 'cua-toggle-global-mark
"cua-gmrk" nil t nil
)
602 ;; Stub definitions until cua-gmrk.el is loaded
604 (when (not (featurep 'cua-gmrk
))
605 (defvar cua--global-mark-active
)
606 (setq cua--global-mark-active nil
))
617 ;;; Low-level Interface
619 (defvar cua-inhibit-cua-keys nil
620 "Buffer-local variable that may disable the CUA keymappings.")
621 (make-variable-buffer-local 'cua-inhibit-cua-keys
)
625 ;; Current region was started using cua-set-mark.
626 (defvar cua--explicit-region-start nil
)
627 (make-variable-buffer-local 'cua--explicit-region-start
)
629 ;; Latest region was started using shifted movement command.
630 (defvar cua--last-region-shifted nil
)
632 ;; buffer + point prior to current command when rectangle is active
633 ;; checked in post-command hook to see if point was moved
634 (defvar cua--buffer-and-point-before-command nil
)
636 ;; status string for mode line indications
637 (defvar cua--status-string nil
)
638 (make-variable-buffer-local 'cua--status-string
)
640 (defvar cua--debug nil
)
643 ;;; Prefix key override mechanism
645 ;; The prefix override (when mark-active) operates in three substates:
646 ;; [1] Before using a prefix key
647 ;; [2] Immediately after using a prefix key
648 ;; [3] A fraction of a second later
650 ;; In state [1], the cua--prefix-override-keymap is active.
651 ;; This keymap binds the C-x and C-c prefix keys to the
652 ;; cua--prefix-override-handler function.
654 ;; When a prefix key is typed in state [1], cua--prefix-override-handler
655 ;; will push back the keys already read to the event queue. If input is
656 ;; pending, it changes directly to state [3]. Otherwise, a short timer [T]
657 ;; is started, and it changes to state [2].
659 ;; In state [2], the cua--prefix-override-keymap is inactive. Instead the
660 ;; cua--prefix-repeat-keymap is active. This keymap binds C-c C-c and C-x
661 ;; C-x to the cua--prefix-repeat-handler function.
663 ;; If the prefix key is repeated in state [2], cua--prefix-repeat-handler
664 ;; will cancel [T], back the keys already read (except for the second prefix
665 ;; keys) to the event queue, and changes to state [3].
667 ;; The basic cua--cua-keys-keymap binds [C-x timeout] to kill-region and
668 ;; [C-c timeout] to copy-region-as-kill, so if [T] times out in state [2],
669 ;; the cua--prefix-override-timeout function will push a `timeout' event on
670 ;; the event queue, and changes to state [3].
672 ;; In state [3] both cua--prefix-override-keymap and cua--prefix-repeat-keymap
673 ;; are inactive, so the timeout in cua-global-keymap binding is used, or the
674 ;; normal prefix key binding from the global or local map will be used.
676 ;; The pre-command hook (executed as a consequence of the timeout or normal
677 ;; prefix key binding) will cancel [T] and change from state [3] back to
678 ;; state [1]. So cua--prefix-override-handler and cua--prefix-repeat-handler
679 ;; are always called with state reset to [1]!
681 ;; State [1] is recognized by cua--prefix-override-timer is nil,
682 ;; state [2] is recognized by cua--prefix-override-timer is a timer, and
683 ;; state [3] is recognized by cua--prefix-override-timer is t.
685 (defvar cua--prefix-override-timer nil
)
686 (defvar cua--prefix-override-length nil
)
688 (defun cua--prefix-override-replay (arg repeat
)
689 (let* ((keys (this-command-keys))
691 (key (aref keys
(1- i
))))
692 (setq cua--prefix-override-length
(- i repeat
))
693 (setq cua--prefix-override-timer
695 ;; In state [2], change to state [3]
697 ;; In state [1], change directly to state [3]
698 (and cua-check-pending-input
(input-pending-p))
699 ;; In state [1], [T] disabled, so change to state [3]
700 (not (numberp cua-prefix-override-inhibit-delay
))
701 (<= cua-prefix-override-inhibit-delay
0)
702 ;; In state [1], start [T] and change to state [2]
703 (run-with-timer cua-prefix-override-inhibit-delay nil
704 'cua--prefix-override-timeout
)))
705 ;; Don't record this command
706 (setq this-command last-command
)
707 ;; Restore the prefix arg
708 (setq prefix-arg arg
)
709 (reset-this-command-lengths)
710 ;; Push the key back on the event queue
711 (setq unread-command-events
(cons key unread-command-events
))))
713 (defun cua--prefix-override-handler (arg)
714 "Start timer waiting for prefix key to be followed by another key.
715 Repeating prefix key when region is active works as a single prefix key."
717 (cua--prefix-override-replay arg
0))
719 (defun cua--prefix-repeat-handler (arg)
720 "Repeating prefix key when region is active works as a single prefix key."
722 (cua--prefix-override-replay arg
1))
724 (defun cua--prefix-copy-handler (arg)
725 "Copy region/rectangle, then replay last key."
728 (cua-copy-rectangle arg
)
729 (cua-copy-region arg
))
730 (let ((keys (this-single-command-keys)))
731 (setq unread-command-events
732 (cons (aref keys
(1- (length keys
))) unread-command-events
))))
734 (defun cua--prefix-cut-handler (arg)
735 "Cut region/rectangle, then replay last key."
738 (cua-cut-rectangle arg
)
739 (cua-cut-region arg
))
740 (let ((keys (this-single-command-keys)))
741 (setq unread-command-events
742 (cons (aref keys
(1- (length keys
))) unread-command-events
))))
744 (defun cua--prefix-override-timeout ()
745 (setq cua--prefix-override-timer t
)
746 (when (= (length (this-command-keys)) cua--prefix-override-length
)
747 (setq unread-command-events
(cons 'timeout unread-command-events
))
749 (reset-this-command-lengths)
750 (setq overriding-terminal-local-map nil
))
751 (cua--select-keymaps)))
756 (defun cua--fallback ()
757 ;; Execute original command
758 (setq this-command this-original-command
)
759 (call-interactively this-command
))
761 (defun cua--keep-active ()
763 deactivate-mark nil
))
765 (defun cua--deactivate (&optional now
)
766 (setq cua--explicit-region-start nil
)
768 (setq deactivate-mark t
)
769 (setq mark-active nil
)
770 (run-hooks 'deactivate-mark-hook
)))
773 ;; The current register prefix
774 (defvar cua--register nil
)
776 (defun cua--prefix-arg (arg)
778 (and cua-enable-register-prefix
779 (integerp arg
) (>= arg
0) (< arg
10)
780 (let* ((prefix (aref (this-command-keys) 0))
781 (ctrl-u-prefix (and (integerp prefix
)
784 ((eq cua-enable-register-prefix
'not-ctrl-u
)
786 ((eq cua-enable-register-prefix
'ctrl-u-only
)
790 (if cua--register nil arg
))
793 ;;; Region specific commands
795 (defvar cua--last-deleted-region-pos nil
)
796 (defvar cua--last-deleted-region-text nil
)
798 (defun cua-delete-region ()
799 "Delete the active region.
800 Save a copy in register 0 if `cua-delete-copy-to-register-0' is non-nil."
802 (let ((start (mark)) (end (point)))
804 (setq start
(prog1 end
(setq end start
))))
805 (setq cua--last-deleted-region-text
(filter-buffer-substring start end
))
806 (if cua-delete-copy-to-register-0
807 (set-register ?
0 cua--last-deleted-region-text
))
808 (delete-region start end
)
809 (setq cua--last-deleted-region-pos
810 (cons (current-buffer)
811 (and (consp buffer-undo-list
)
812 (car buffer-undo-list
))))
816 (defun cua-replace-region ()
817 "Replace the active region with the character you type."
819 (let ((not-empty (and cua-delete-selection
(cua-delete-region))))
820 (unless (eq this-original-command this-command
)
821 (let ((overwrite-mode
824 (not (eq this-original-command
'self-insert-command
)))))
827 (defun cua-copy-region (arg)
828 "Copy the region to the kill ring.
829 With numeric prefix arg, copy to register 0-9 instead."
831 (setq arg
(cua--prefix-arg arg
))
832 (setq cua--last-killed-rectangle nil
)
833 (let ((start (mark)) (end (point)))
835 (setq start
(prog1 end
(setq end start
))))
838 (copy-to-register cua--register start end nil
))
839 ((eq this-original-command
'clipboard-kill-ring-save
)
840 (clipboard-kill-ring-save start end
))
842 (copy-region-as-kill start end
)))
843 (if cua-keep-region-after-copy
847 (defun cua-cut-region (arg)
848 "Cut the region and copy to the kill ring.
849 With numeric prefix arg, copy to register 0-9 instead."
851 (setq cua--last-killed-rectangle nil
)
853 (cua-copy-region arg
)
854 (setq arg
(cua--prefix-arg arg
))
855 (let ((start (mark)) (end (point)))
857 (setq start
(prog1 end
(setq end start
))))
860 (copy-to-register cua--register start end t
))
861 ((eq this-original-command
'clipboard-kill-region
)
862 (clipboard-kill-region start end
))
864 (kill-region start end
))))
867 ;;; Generic commands for regions, rectangles, and global marks
870 "Cancel the active region, rectangle, or global mark."
872 (setq mark-active nil
)
873 (setq cua--explicit-region-start nil
)
874 (if (fboundp 'cua--cancel-rectangle
)
875 (cua--cancel-rectangle)))
877 (defun cua-paste (arg)
878 "Paste last cut or copied region or rectangle.
879 An active region is deleted before executing the command.
880 With numeric prefix arg, paste from register 0-9 instead.
881 If global mark is active, copy from register or one character."
883 (setq arg
(cua--prefix-arg arg
))
884 (let ((regtxt (and cua--register
(get-register cua--register
)))
885 (count (prefix-numeric-value arg
))
886 paste-column paste-lines
)
888 ((and cua--register
(not regtxt
))
889 (message "Nothing in register %c" cua--register
))
890 (cua--global-mark-active
892 (cua--insert-at-global-mark regtxt
)
894 (cua--insert-at-global-mark (filter-buffer-substring (point) (+ (point) count
)))
895 (forward-char count
))))
897 (message "Cannot paste into a read-only buffer"))
899 ;; Must save register here, since delete may override reg 0.
901 ;; Before a yank command, make sure we don't yank
902 ;; the same region that we are going to delete.
903 ;; That would make yank a no-op.
906 (goto-char (min (mark) (point)))
907 (setq paste-column
(cua--rectangle-left))
908 (setq paste-lines
(cua--delete-rectangle))
909 (if (= paste-lines
1)
910 (setq paste-lines nil
))) ;; paste all
911 (if (string= (filter-buffer-substring (point) (mark))
914 (cua-delete-region)))
918 ((consp regtxt
) (cua--insert-rectangle regtxt
))
919 ((stringp regtxt
) (insert-for-yank regtxt
))
920 (t (message "Unknown data in register %c" cua--register
))))
921 ((and cua--last-killed-rectangle
922 (eq (and kill-ring
(car kill-ring
)) (car cua--last-killed-rectangle
)))
924 (when (not (eq buffer-undo-list t
))
925 (setq this-command
'cua--paste-rectangle
)
927 (setq buffer-undo-list
(cons pt buffer-undo-list
)))
928 (cua--insert-rectangle (cdr cua--last-killed-rectangle
)
929 nil paste-column paste-lines
)
930 (if arg
(goto-char pt
))))
931 ((eq this-original-command
'clipboard-yank
)
933 ((eq this-original-command
'x-clipboard-yank
)
938 ;; cua-paste-pop-rotate-temporarily == t mechanism:
940 ;; C-y M-y M-y => only rotates kill ring temporarily,
941 ;; so next C-y yanks what previous C-y yanked,
943 ;; M-y M-y M-y => equivalent to C-y M-y M-y
945 ;; But: After another command, C-u M-y remembers the temporary
946 ;; kill-ring position, so
947 ;; C-u M-y => yanks what the last M-y yanked
950 (defvar cua-paste-pop-count nil
)
952 (defun cua-paste-pop (arg)
953 "Replace a just-pasted text or rectangle with a different text.
954 See `yank-pop' for details about the default behaviour. For an alternative
955 behaviour, see `cua-paste-pop-rotate-temporarily'."
958 ((eq last-command
'cua--paste-rectangle
)
961 ((not cua-paste-pop-rotate-temporarily
)
962 (yank-pop (prefix-numeric-value arg
)))
964 (let ((rotate (if (consp arg
) 1 (prefix-numeric-value arg
))))
966 ((or (null cua-paste-pop-count
)
967 (eq last-command
'yank
)
968 (eq last-command
'cua-paste
))
969 (setq cua-paste-pop-count rotate
)
970 (setq last-command
'yank
)
971 (yank-pop cua-paste-pop-count
))
972 ((and (eq last-command
'cua-paste-pop
) (not (consp arg
)))
973 (setq cua-paste-pop-count
(+ cua-paste-pop-count rotate
))
974 (setq last-command
'yank
)
975 (yank-pop cua-paste-pop-count
))
977 (setq cua-paste-pop-count
978 (if (consp arg
) (+ cua-paste-pop-count rotate -
1) 1))
979 (yank (1+ cua-paste-pop-count
)))))
980 ;; Undo rotating the kill-ring, so next C-y will
981 ;; yank the original head.
982 (setq kill-ring-yank-pointer kill-ring
)
983 (setq this-command
'cua-paste-pop
))))
985 (defun cua-exchange-point-and-mark (arg)
986 "Exchanges point and mark, but don't activate the mark.
987 Activates the mark if a prefix argument is given."
992 (exchange-point-and-mark)
994 (cua--rectangle-corner 0)))))
996 ;; Typed text that replaced the highlighted region.
997 (defvar cua--repeat-replace-text nil
)
999 (defun cua-repeat-replace-region (arg)
1000 "Repeat replacing text of highlighted region with typed text.
1001 Searches for the next stretch of text identical to the region last
1002 replaced by typing text over it and replaces it with the same stretch
1005 (when cua--last-deleted-region-pos
1008 (set-buffer (car cua--last-deleted-region-pos
))
1010 ;; Find the text that replaced the region via the undo list.
1011 (let ((ul buffer-undo-list
)
1012 (elt (cdr cua--last-deleted-region-pos
))
1016 (setq u
(car ul
) ul
(cdr ul
))
1018 ((eq u elt
) ;; got it
1020 ((and (consp u
) (integerp (car u
)) (integerp (cdr u
)))
1021 (if (and s
(= (cdr u
) s
))
1023 (setq s
(car u
) e
(cdr u
)))))))
1024 (cond ((and s e
(<= s e
) (= s
(mark t
)))
1025 (setq cua--repeat-replace-text
1026 (filter-buffer-substring s e nil t
)))
1027 ((and (null s
) (eq u elt
)) ;; nothing inserted
1028 (setq cua--repeat-replace-text
1031 (message "Cannot locate replacement text"))))))
1032 (setq cua--last-deleted-region-pos nil
))
1033 (if (and cua--last-deleted-region-text
1034 cua--repeat-replace-text
1035 (search-forward cua--last-deleted-region-text nil t nil
))
1036 (replace-match cua--repeat-replace-text arg t
)))
1038 (defun cua-help-for-region (&optional help
)
1039 "Show region specific help in echo area."
1042 (concat (if help
"C-?:help " "")
1043 "C-z:undo C-x:cut C-c:copy C-v:paste S-ret:rect")))
1046 ;;; Shift activated / extended region
1048 (defun cua-pop-to-last-change ()
1049 (let ((undo-list buffer-undo-list
)
1051 (while (and (not pos
)
1053 (setq elt
(car undo-list
)
1054 undo-list
(cdr undo-list
))
1059 ((and (integerp (cdr elt
))
1060 (or (integerp (car elt
)) (stringp (car elt
))))
1061 (setq pos
(cdr elt
)))
1062 ((and (eq (car elt
) 'apply
) (consp (cdr elt
)) (integerp (cadr elt
)))
1063 (setq pos
(nth 3 elt
)))))
1066 (>= pos
(point-min)) (<= pos
(point-max)))
1070 (defun cua-set-mark (&optional arg
)
1071 "Set mark at where point is, clear mark, or jump to mark.
1073 With no prefix argument, clear mark if already set. Otherwise, set
1074 mark, and push old mark position on local mark ring; also push mark on
1075 global mark ring if last mark was set in another buffer.
1077 With argument, jump to mark, and pop a new position for mark off
1078 the local mark ring (this does not affect the global mark ring).
1079 Use \\[pop-global-mark] to jump to a mark off the global mark ring
1080 \(see `pop-global-mark').
1082 If `cua-auto-mark-last-change' is non-nil, this command behaves as if there
1083 was an implicit mark at the position of the last buffer change.
1085 Repeating the command without the prefix jumps to the next position
1086 off the local (or global) mark ring.
1088 With a double \\[universal-argument] prefix argument, unconditionally set mark."
1091 ((and (consp arg
) (> (prefix-numeric-value arg
) 4))
1092 (push-mark-command nil
))
1093 ((eq last-command
'pop-to-mark-command
)
1094 (setq this-command
'pop-to-mark-command
)
1095 (pop-to-mark-command))
1096 ((and (eq last-command
'pop-global-mark
) (not arg
))
1097 (setq this-command
'pop-global-mark
)
1100 (setq this-command
'pop-to-mark-command
)
1101 (or (and cua-auto-mark-last-change
1102 (cua-pop-to-last-change))
1103 (pop-to-mark-command)))
1104 ((and cua-toggle-set-mark mark-active
)
1106 (message "Mark Cleared"))
1108 (push-mark-command nil nil
)
1109 (setq cua--explicit-region-start t
)
1110 (setq cua--last-region-shifted nil
)
1111 (if cua-enable-region-auto-help
1112 (cua-help-for-region t
)))))
1114 ;;; Scrolling commands which does not signal errors at top/bottom
1115 ;;; of buffer at first key-press (instead moves to top/bottom
1118 (defun cua-scroll-up (&optional arg
)
1119 "Scroll text of current window upward ARG lines; or near full screen if no ARG.
1120 If window cannot be scrolled further, move cursor to bottom line instead.
1121 A near full screen is `next-screen-context-lines' less than a full screen.
1122 Negative ARG means scroll downward.
1123 If ARG is the atom `-', scroll downward by nearly full screen."
1126 ((eq arg
'-
) (cua-scroll-down nil
))
1127 ((< (prefix-numeric-value arg
) 0)
1128 (cua-scroll-down (- (prefix-numeric-value arg
))))
1130 (scroll-up arg
)) ; signal error
1134 (end-of-buffer (goto-char (point-max)))))))
1136 (put 'cua-scroll-up
'CUA
'move
)
1138 (defun cua-scroll-down (&optional arg
)
1139 "Scroll text of current window downward ARG lines; or near full screen if no ARG.
1140 If window cannot be scrolled further, move cursor to top line instead.
1141 A near full screen is `next-screen-context-lines' less than a full screen.
1142 Negative ARG means scroll upward.
1143 If ARG is the atom `-', scroll upward by nearly full screen."
1146 ((eq arg
'-
) (cua-scroll-up nil
))
1147 ((< (prefix-numeric-value arg
) 0)
1148 (cua-scroll-up (- (prefix-numeric-value arg
))))
1150 (scroll-down arg
)) ; signal error
1154 (beginning-of-buffer (goto-char (point-min)))))))
1156 (put 'cua-scroll-down
'CUA
'move
)
1158 ;;; Cursor indications
1160 (defun cua--update-indications ()
1163 ((and cua--global-mark-active
1164 cua-global-mark-cursor-color
)
1165 cua-global-mark-cursor-color
)
1166 ((and buffer-read-only
1167 cua-read-only-cursor-color
)
1168 cua-read-only-cursor-color
)
1169 ((and cua-overwrite-cursor-color overwrite-mode
)
1170 cua-overwrite-cursor-color
)
1171 (t cua-normal-cursor-color
)))
1172 (color (if (consp cursor
) (cdr cursor
) cursor
))
1173 (type (if (consp cursor
) (car cursor
) cursor
)))
1176 (not (equal color
(frame-parameter nil
'cursor-color
))))
1177 (set-cursor-color color
))
1180 (not (eq type default-cursor-type
)))
1181 (setq default-cursor-type type
))))
1184 ;;; Pre-command hook
1186 (defun cua--pre-command-handler-1 ()
1187 ;; Cancel prefix key timeout if user enters another key.
1188 (when cua--prefix-override-timer
1189 (if (timerp cua--prefix-override-timer
)
1190 (cancel-timer cua--prefix-override-timer
))
1191 (setq cua--prefix-override-timer nil
))
1194 ;; Only symbol commands can have necessary properties
1195 ((not (symbolp this-command
))
1198 ;; Handle delete-selection property on non-movement commands
1199 ((not (eq (get this-command
'CUA
) 'move
))
1200 (when (and mark-active
(not deactivate-mark
))
1201 (let* ((ds (or (get this-command
'delete-selection
)
1202 (get this-command
'pending-delete
)))
1213 'cua-delete-rectangle
1214 'cua-delete-region
))
1217 'cua-delete-rectangle
;; replace?
1218 'cua-replace-region
)))))
1220 (setq this-original-command this-command
1221 this-command nc
)))))
1223 ;; Handle shifted cursor keys and other movement commands.
1224 ;; If region is not active, region is activated if key is shifted.
1225 ;; If region is active, region is cancelled if key is unshifted (and region not started with C-SPC).
1226 ;; If rectangle is active, expand rectangle in specified direction and ignore the movement.
1228 (memq 'shift
(event-modifiers
1229 (aref (this-single-command-raw-keys) 0)))
1231 (memq 'shift
(event-modifiers
1232 (aref (this-single-command-keys) 0)))
1233 ;; See if raw escape sequence maps to a shifted event, e.g. S-up or C-S-home.
1234 (and (boundp 'function-key-map
)
1236 (let ((ev (lookup-key function-key-map
1237 (this-single-command-raw-keys))))
1239 (symbolp (setq ev
(aref ev
0)))
1240 (string-match "S-" (symbol-name ev
)))))))
1242 (push-mark-command nil t
))
1243 (setq cua--last-region-shifted t
)
1244 (setq cua--explicit-region-start nil
))
1246 ;; Set mark if user explicitly said to do so
1247 ((or cua--explicit-region-start cua--rectangle
)
1249 (push-mark-command nil nil
)))
1251 ;; Else clear mark after this command.
1253 ;; If we set mark-active to nil here, the region highlight will not be
1254 ;; removed by the direct_output_ commands.
1255 (setq deactivate-mark t
)))
1257 ;; Detect extension of rectangles by mouse or other movement
1258 (setq cua--buffer-and-point-before-command
1259 (if cua--rectangle
(cons (current-buffer) (point)))))
1261 (defun cua--pre-command-handler ()
1264 (cua--pre-command-handler-1)
1267 ;;; Post-command hook
1269 (defun cua--post-command-handler-1 ()
1270 (when cua--global-mark-active
1271 (cua--global-mark-post-command))
1272 (when (fboundp 'cua--rectangle-post-command
)
1273 (cua--rectangle-post-command))
1274 (setq cua--buffer-and-point-before-command nil
)
1275 (if (or (not mark-active
) deactivate-mark
)
1276 (setq cua--explicit-region-start nil
))
1281 (cua--rectangle (cua--rectangle-assert))
1282 (mark-active (message "Mark=%d Point=%d Expl=%s"
1283 (mark t
) (point) cua--explicit-region-start
))))
1285 ;; Disable transient-mark-mode if rectangle active in current buffer.
1286 (if (not (window-minibuffer-p (selected-window)))
1287 (setq transient-mark-mode
(and (not cua--rectangle
)
1288 (if cua-highlight-region-shift-only
1289 (not cua--explicit-region-start
)
1291 (if cua-enable-cursor-indications
1292 (cua--update-indications))
1294 (cua--select-keymaps))
1296 (defun cua--post-command-handler ()
1299 (cua--post-command-handler-1)
1305 ;; Cached value of actual cua-rectangle-modifier-key
1306 (defvar cua--rectangle-modifier-key
'meta
)
1308 (defun cua--M/H-key
(map key fct
)
1309 ;; bind H-KEY or M-KEY to FCT in MAP
1310 (unless (listp key
) (setq key
(list key
)))
1311 (define-key map
(vector (cons cua--rectangle-modifier-key key
)) fct
))
1313 (defun cua--self-insert-char-p (def)
1314 ;; Return DEF if current key sequence is self-inserting in
1316 (if (memq (global-key-binding (this-single-command-keys))
1317 '(self-insert-command self-insert-iso
))
1320 (defvar cua-global-keymap
(make-sparse-keymap)
1321 "Global keymap for cua-mode; users may add to this keymap.")
1323 (defvar cua--cua-keys-keymap
(make-sparse-keymap))
1324 (defvar cua--prefix-override-keymap
(make-sparse-keymap))
1325 (defvar cua--prefix-repeat-keymap
(make-sparse-keymap))
1326 (defvar cua--global-mark-keymap
(make-sparse-keymap)) ; Initalized when cua-gmrk.el is loaded
1327 (defvar cua--rectangle-keymap
(make-sparse-keymap)) ; Initalized when cua-rect.el is loaded
1328 (defvar cua--region-keymap
(make-sparse-keymap))
1330 (defvar cua--ena-cua-keys-keymap nil
)
1331 (defvar cua--ena-prefix-override-keymap nil
)
1332 (defvar cua--ena-prefix-repeat-keymap nil
)
1333 (defvar cua--ena-region-keymap nil
)
1334 (defvar cua--ena-global-mark-keymap nil
)
1336 (defvar cua--keymap-alist
1337 `((cua--ena-prefix-override-keymap .
,cua--prefix-override-keymap
)
1338 (cua--ena-prefix-repeat-keymap .
,cua--prefix-repeat-keymap
)
1339 (cua--ena-cua-keys-keymap .
,cua--cua-keys-keymap
)
1340 (cua--ena-global-mark-keymap .
,cua--global-mark-keymap
)
1341 (cua--rectangle .
,cua--rectangle-keymap
)
1342 (cua--ena-region-keymap .
,cua--region-keymap
)
1343 (cua-mode .
,cua-global-keymap
)))
1345 (defun cua--select-keymaps ()
1346 ;; Setup conditions for selecting the proper keymaps in cua--keymap-alist.
1347 (setq cua--ena-region-keymap
1348 (and mark-active
(not deactivate-mark
)))
1349 (setq cua--ena-prefix-override-keymap
1350 (and cua--ena-region-keymap
1352 (not cua-inhibit-cua-keys
)
1353 (or (eq cua-enable-cua-keys t
)
1354 (not cua--explicit-region-start
))
1355 (not executing-kbd-macro
)
1356 (not cua--prefix-override-timer
)))
1357 (setq cua--ena-prefix-repeat-keymap
1358 (and cua--ena-region-keymap
1359 (or (timerp cua--prefix-override-timer
)
1360 (eq cua--prefix-override-timer
'shift
))))
1361 (setq cua--ena-cua-keys-keymap
1362 (and cua-enable-cua-keys
1363 (not cua-inhibit-cua-keys
)
1364 (or (eq cua-enable-cua-keys t
)
1365 cua--last-region-shifted
)))
1366 (setq cua--ena-global-mark-keymap
1367 (and cua--global-mark-active
1368 (not (window-minibuffer-p)))))
1370 (defvar cua--keymaps-initalized nil
)
1372 (defun cua--shift-control-prefix (prefix arg
)
1373 ;; handle S-C-x and S-C-c by emulating the fast double prefix function.
1374 ;; Don't record this command
1375 (setq this-command last-command
)
1376 ;; Restore the prefix arg
1377 (setq prefix-arg arg
)
1378 (reset-this-command-lengths)
1379 ;; Activate the cua--prefix-repeat-keymap
1380 (setq cua--prefix-override-timer
'shift
)
1381 ;; Push duplicate keys back on the event queue
1382 (setq unread-command-events
(cons prefix
(cons prefix unread-command-events
))))
1384 (defun cua--shift-control-c-prefix (arg)
1386 (cua--shift-control-prefix ?\C-c arg
))
1388 (defun cua--shift-control-x-prefix (arg)
1390 (cua--shift-control-prefix ?\C-x arg
))
1392 (defun cua--init-keymaps ()
1393 ;; Cache actual rectangle modifier key.
1394 (setq cua--rectangle-modifier-key
1395 (if (and cua-rectangle-modifier-key
1396 (memq window-system
'(x)))
1397 cua-rectangle-modifier-key
1399 ;; C-return always toggles rectangle mark
1400 (define-key cua-global-keymap cua-rectangle-mark-key
'cua-set-rectangle-mark
)
1401 (unless (eq cua--rectangle-modifier-key
'meta
)
1402 (cua--M/H-key cua-global-keymap ?\s
'cua-set-rectangle-mark
)
1403 (define-key cua-global-keymap
1404 (vector (list cua--rectangle-modifier-key
'mouse-1
)) 'cua-mouse-set-rectangle-mark
))
1406 (define-key cua-global-keymap
[(shift control ?\s
)] 'cua-toggle-global-mark
)
1408 ;; replace region with rectangle or element on kill ring
1409 (define-key cua-global-keymap
[remap yank
] 'cua-paste
)
1410 (define-key cua-global-keymap
[remap clipboard-yank
] 'cua-paste
)
1411 (define-key cua-global-keymap
[remap x-clipboard-yank
] 'cua-paste
)
1412 ;; replace current yank with previous kill ring element
1413 (define-key cua-global-keymap
[remap yank-pop
] 'cua-paste-pop
)
1415 (define-key cua-global-keymap
[remap set-mark-command
] 'cua-set-mark
)
1418 (define-key cua-global-keymap
[remap scroll-up
] 'cua-scroll-up
)
1419 (define-key cua-global-keymap
[remap scroll-down
] 'cua-scroll-down
)
1421 (define-key cua--cua-keys-keymap
[(control x
) timeout
] 'kill-region
)
1422 (define-key cua--cua-keys-keymap
[(control c
) timeout
] 'copy-region-as-kill
)
1423 (define-key cua--cua-keys-keymap
[(control z
)] 'undo
)
1424 (define-key cua--cua-keys-keymap
[(control v
)] 'yank
)
1425 (define-key cua--cua-keys-keymap
[(meta v
)] 'cua-repeat-replace-region
)
1426 (define-key cua--cua-keys-keymap
[remap exchange-point-and-mark
] 'cua-exchange-point-and-mark
)
1428 (define-key cua--prefix-override-keymap
[(control x
)] 'cua--prefix-override-handler
)
1429 (define-key cua--prefix-override-keymap
[(control c
)] 'cua--prefix-override-handler
)
1431 (define-key cua--prefix-repeat-keymap
[(control x
) (control x
)] 'cua--prefix-repeat-handler
)
1432 (define-key cua--prefix-repeat-keymap
[(control x
) up
] 'cua--prefix-cut-handler
)
1433 (define-key cua--prefix-repeat-keymap
[(control x
) down
] 'cua--prefix-cut-handler
)
1434 (define-key cua--prefix-repeat-keymap
[(control x
) left
] 'cua--prefix-cut-handler
)
1435 (define-key cua--prefix-repeat-keymap
[(control x
) right
] 'cua--prefix-cut-handler
)
1436 (define-key cua--prefix-repeat-keymap
[(control c
) (control c
)] 'cua--prefix-repeat-handler
)
1437 (define-key cua--prefix-repeat-keymap
[(control c
) up
] 'cua--prefix-copy-handler
)
1438 (define-key cua--prefix-repeat-keymap
[(control c
) down
] 'cua--prefix-copy-handler
)
1439 (define-key cua--prefix-repeat-keymap
[(control c
) left
] 'cua--prefix-copy-handler
)
1440 (define-key cua--prefix-repeat-keymap
[(control c
) right
] 'cua--prefix-copy-handler
)
1442 ;; Enable shifted fallbacks for C-x and C-c when region is active
1443 (define-key cua--region-keymap
[(shift control x
)] 'cua--shift-control-x-prefix
)
1444 (define-key cua--region-keymap
[(shift control c
)] 'cua--shift-control-c-prefix
)
1446 ;; replace current region
1447 (define-key cua--region-keymap
[remap self-insert-command
] 'cua-replace-region
)
1448 (define-key cua--region-keymap
[remap self-insert-iso
] 'cua-replace-region
)
1449 (define-key cua--region-keymap
[remap insert-register
] 'cua-replace-region
)
1450 (define-key cua--region-keymap
[remap newline-and-indent
] 'cua-replace-region
)
1451 (define-key cua--region-keymap
[remap newline
] 'cua-replace-region
)
1452 (define-key cua--region-keymap
[remap open-line
] 'cua-replace-region
)
1453 ;; delete current region
1454 (define-key cua--region-keymap
[remap delete-backward-char
] 'cua-delete-region
)
1455 (define-key cua--region-keymap
[remap backward-delete-char
] 'cua-delete-region
)
1456 (define-key cua--region-keymap
[remap backward-delete-char-untabify
] 'cua-delete-region
)
1457 (define-key cua--region-keymap
[remap delete-char
] 'cua-delete-region
)
1459 (define-key cua--region-keymap
[remap kill-region
] 'cua-cut-region
)
1460 (define-key cua--region-keymap
[remap clipboard-kill-region
] 'cua-cut-region
)
1462 (define-key cua--region-keymap
[remap copy-region-as-kill
] 'cua-copy-region
)
1463 (define-key cua--region-keymap
[remap kill-ring-save
] 'cua-copy-region
)
1464 (define-key cua--region-keymap
[remap clipboard-kill-ring-save
] 'cua-copy-region
)
1465 ;; cancel current region/rectangle
1466 (define-key cua--region-keymap
[remap keyboard-escape-quit
] 'cua-cancel
)
1467 (define-key cua--region-keymap
[remap keyboard-quit
] 'cua-cancel
)
1471 ;; Setup standard movement commands to be recognized by CUA.
1474 '(forward-char backward-char
1475 next-line previous-line
1476 forward-word backward-word
1477 end-of-line beginning-of-line
1478 move-end-of-line move-beginning-of-line
1479 end-of-buffer beginning-of-buffer
1480 scroll-up scroll-down
1481 up-list down-list backward-up-list
1482 end-of-defun
beginning-of-defun
1483 forward-sexp backward-sexp
1484 forward-list backward-list
1485 forward-sentence backward-sentence
1486 forward-paragraph backward-paragraph
))
1487 (put cmd
'CUA
'move
))
1489 ;; State prior to enabling cua-mode
1490 ;; Value is a list with the following elements:
1491 ;; transient-mark-mode
1492 ;; delete-selection-mode
1493 ;; pc-selection-mode
1495 (defvar cua--saved-state nil
)
1498 (define-minor-mode cua-mode
1499 "Toggle CUA key-binding mode.
1500 When enabled, using shifted movement keys will activate the
1501 region (and highlight the region using `transient-mark-mode'),
1502 and typed text replaces the active selection.
1504 Also when enabled, you can use C-z, C-x, C-c, and C-v to undo,
1505 cut, copy, and paste in addition to the normal Emacs bindings.
1506 The C-x and C-c keys only do cut and copy when the region is
1507 active, so in most cases, they do not conflict with the normal
1508 function of these prefix keys.
1510 If you really need to perform a command which starts with one of
1511 the prefix keys even when the region is active, you have three
1513 - press the prefix key twice very quickly (within 0.2 seconds),
1514 - press the prefix key and the following key within 0.2 seconds, or
1515 - use the SHIFT key with the prefix key, i.e. C-S-x or C-S-c.
1517 You can customize `cua-enable-cua-keys' to completely disable the
1518 CUA bindings, or `cua-prefix-override-inhibit-delay' to change
1519 the prefix fallback behavior.
1521 CUA mode manages Transient Mark mode internally. Trying to disable
1522 Transient Mark mode while CUA mode is enabled does not work; if you
1523 only want to highlight the region when it is selected using a
1524 shifted movement key, set `cua-highlight-region-shift-only'."
1527 :set-after
'(cua-enable-modeline-indications
1528 cua-rectangle-mark-key cua-rectangle-modifier-key
)
1530 :link
'(emacs-commentary-link "cua-base.el")
1531 (setq mark-even-if-inactive t
)
1532 (setq highlight-nonselected-windows nil
)
1534 (unless cua--keymaps-initalized
1536 (setq cua--keymaps-initalized t
))
1540 (add-hook 'pre-command-hook
'cua--pre-command-handler
)
1541 (add-hook 'post-command-hook
'cua--post-command-handler
)
1542 (if (and cua-enable-modeline-indications
(not (assoc 'cua-mode minor-mode-alist
)))
1543 (setq minor-mode-alist
(cons '(cua-mode cua--status-string
) minor-mode-alist
)))
1544 (if cua-enable-cursor-indications
1545 (cua--update-indications)))
1547 (remove-hook 'pre-command-hook
'cua--pre-command-handler
)
1548 (remove-hook 'post-command-hook
'cua--post-command-handler
))
1551 (setq emulation-mode-map-alists
(delq 'cua--keymap-alist emulation-mode-map-alists
))
1552 (add-to-ordered-list 'emulation-mode-map-alists
'cua--keymap-alist
400)
1553 (cua--select-keymaps))
1557 (setq cua--saved-state
1560 (and (boundp 'delete-selection-mode
) delete-selection-mode
)
1561 (and (boundp 'pc-selection-mode
) pc-selection-mode
)))
1562 (if (and (boundp 'delete-selection-mode
) delete-selection-mode
)
1563 (delete-selection-mode -
1))
1564 (if (and (boundp 'pc-selection-mode
) pc-selection-mode
)
1565 (pc-selection-mode -
1))
1567 (setq transient-mark-mode
(and cua-mode
1568 (if cua-highlight-region-shift-only
1569 (not cua--explicit-region-start
)
1572 (setq transient-mark-mode
(car cua--saved-state
))
1573 (if (nth 1 cua--saved-state
)
1574 (delete-selection-mode 1))
1575 (if (nth 2 cua--saved-state
)
1576 (pc-selection-mode 1))
1578 (message "CUA mode disabled.%s%s%s%s"
1579 (if (nth 1 cua--saved-state
) " Delete-Selection" "")
1580 (if (and (nth 1 cua--saved-state
) (nth 2 cua--saved-state
)) " and" "")
1581 (if (nth 2 cua--saved-state
) " PC-Selection" "")
1582 (if (or (nth 1 cua--saved-state
) (nth 2 cua--saved-state
)) " enabled" "")))
1583 (setq cua--saved-state nil
))))
1587 (defun cua-selection-mode (arg)
1588 "Enable CUA selection mode without the C-z/C-x/C-c/C-v bindings."
1590 (setq-default cua-enable-cua-keys nil
)
1595 "Toggle CUA debugging."
1597 (setq cua--debug
(not cua--debug
)))
1601 ;;; arch-tag: 21fb6289-ba25-4fee-bfdc-f9fb351acf05
1602 ;;; cua-base.el ends here