Clean up previous change.
[emacs.git] / lisp / emulation / cua-base.el
blob2d169e889cdc50420401cd6d3bb800b614453d0e
1 ;;; cua-base.el --- emulate CUA key bindings
3 ;; Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006 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 2, or (at your option)
14 ;; any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
27 ;;; Commentary:
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 &
32 ;; extend the region.
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.
39 ;; C-z -> undo
40 ;; C-x -> cut
41 ;; C-c -> copy
42 ;; C-v -> paste
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
50 ;; keys
51 ;; C-x -> cut
52 ;; C-c -> copy
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
136 ;; using [M-0 C-v].
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
184 ;; direction.
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
205 ;; of the rectangle
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].
234 ;; CUA Global Mark
235 ;; ---------------
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
241 ;; mark is set:
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
250 ;; global mark.
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
258 ;; global mark.
260 ;;; Code:
262 ;;; Customization
264 (defgroup cua nil
265 "Emulate CUA key bindings including C-x and C-c."
266 :prefix "cua"
267 :group 'editing-basics
268 :group 'convenience
269 :group 'emulations
270 :version "22.1"
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
279 enabled."
280 :type '(choice (const :tag "Disabled" nil)
281 (const :tag "Shift region only" shift)
282 (other :tag "Enabled" t))
283 :group 'cua)
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
290 is not turned on."
291 :type 'boolean
292 :group 'cua)
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))
306 :group 'cua)
308 (defcustom cua-keep-region-after-copy nil
309 "If non-nil, don't deselect the region after copying."
310 :type 'boolean
311 :group 'cua)
313 (defcustom cua-enable-register-prefix 'not-ctrl-u
314 "*If non-nil, registers are supported via numeric prefix arg.
315 If the value is t, any numeric prefix arg in the range 0 to 9 will be
316 interpreted as a register number.
317 If the value is `not-ctrl-u', using C-u to enter a numeric prefix is not
318 interpreted as a register number.
319 If the value is `ctrl-u-only', only numeric prefix entered with C-u is
320 interpreted as a register number."
321 :type '(choice (const :tag "Disabled" nil)
322 (const :tag "Enabled, but C-u arg is not a register" not-ctrl-u)
323 (const :tag "Enabled, but only for C-u arg" ctrl-u-only)
324 (other :tag "Enabled" t))
325 :group 'cua)
327 (defcustom cua-delete-copy-to-register-0 t
328 "*If non-nil, save last deleted region or rectangle to register 0."
329 :type 'boolean
330 :group 'cua)
332 (defcustom cua-enable-region-auto-help nil
333 "*If non-nil, automatically show help for active region."
334 :type 'boolean
335 :group 'cua)
337 (defcustom cua-enable-modeline-indications nil
338 "*If non-nil, use minor-mode hook to show status in mode line."
339 :type 'boolean
340 :group 'cua)
342 (defcustom cua-check-pending-input t
343 "*If non-nil, don't override prefix key if input pending.
344 It is rumoured that `input-pending-p' is unreliable under some window
345 managers, so try setting this to nil, if prefix override doesn't work."
346 :type 'boolean
347 :group 'cua)
350 ;;; Rectangle Customization
352 (defcustom cua-virtual-rectangle-edges t
353 "*If non-nil, rectangles have virtual straight edges.
354 Note that although rectangles are always DISPLAYED with straight edges, the
355 buffer is NOT modified, until you execute a command that actually modifies it.
356 M-p toggles this feature when a rectangle is active."
357 :type 'boolean
358 :group 'cua)
360 (defcustom cua-auto-tabify-rectangles 1000
361 "*If non-nil, automatically tabify after rectangle commands.
362 This basically means that `tabify' is applied to all lines that
363 are modified by inserting or deleting a rectangle. If value is
364 an integer, CUA will look for existing tabs in a region around
365 the rectangle, and only do the conversion if any tabs are already
366 present. The number specifies then number of characters before
367 and after the region marked by the rectangle to search."
368 :type '(choice (number :tag "Auto detect (limit)")
369 (const :tag "Disabled" nil)
370 (other :tag "Enabled" t))
371 :group 'cua)
373 (defcustom cua-rectangle-mark-key [(control return)]
374 "Global key used to toggle the cua rectangle mark."
375 :set #'(lambda (symbol value)
376 (set symbol value)
377 (when (and (boundp 'cua--keymaps-initalized)
378 cua--keymaps-initalized)
379 (define-key cua-global-keymap value
380 'cua-set-rectangle-mark)
381 (when (boundp 'cua--rectangle-keymap)
382 (define-key cua--rectangle-keymap value
383 'cua-clear-rectangle-mark)
384 (define-key cua--region-keymap value
385 'cua-toggle-rectangle-mark))))
386 :type 'key-sequence
387 :group 'cua)
389 (defcustom cua-rectangle-modifier-key 'meta
390 "*Modifier key used for rectangle commands bindings.
391 On non-window systems, always use the meta modifier.
392 Must be set prior to enabling CUA."
393 :type '(choice (const :tag "Meta key" meta)
394 (const :tag "Hyper key" hyper )
395 (const :tag "Super key" super))
396 :group 'cua)
398 (defcustom cua-enable-rectangle-auto-help t
399 "*If non-nil, automatically show help for region, rectangle and global mark."
400 :type 'boolean
401 :group 'cua)
403 (defface cua-rectangle
404 '((default :inherit region)
405 (((class color)) :foreground "white" :background "maroon"))
406 "*Font used by CUA for highlighting the rectangle."
407 :group 'cua)
409 (defface cua-rectangle-noselect
410 '((default :inherit region)
411 (((class color)) :foreground "white" :background "dimgray"))
412 "*Font used by CUA for highlighting the non-selected rectangle lines."
413 :group 'cua)
416 ;;; Global Mark Customization
418 (defcustom cua-global-mark-keep-visible t
419 "*If non-nil, always keep global mark visible in other window."
420 :type 'boolean
421 :group 'cua)
423 (defface cua-global-mark
424 '((((min-colors 88)(class color)) :foreground "black" :background "yellow1")
425 (((class color)) :foreground "black" :background "yellow")
426 (t :bold t))
427 "*Font used by CUA for highlighting the global mark."
428 :group 'cua)
430 (defcustom cua-global-mark-blink-cursor-interval 0.20
431 "*Blink cursor at this interval when global mark is active."
432 :type '(choice (number :tag "Blink interval")
433 (const :tag "No blink" nil))
434 :group 'cua)
437 ;;; Cursor Indication Customization
439 (defcustom cua-enable-cursor-indications nil
440 "*If non-nil, use different cursor colors for indications."
441 :type 'boolean
442 :group 'cua)
444 (defcustom cua-normal-cursor-color (or (and (boundp 'initial-cursor-color) initial-cursor-color)
445 (and (boundp 'initial-frame-alist)
446 (assoc 'cursor-color initial-frame-alist)
447 (cdr (assoc 'cursor-color initial-frame-alist)))
448 (and (boundp 'default-frame-alist)
449 (assoc 'cursor-color default-frame-alist)
450 (cdr (assoc 'cursor-color default-frame-alist)))
451 (frame-parameter nil 'cursor-color)
452 "red")
453 "Normal (non-overwrite) cursor color.
454 Default is to load cursor color from initial or default frame parameters.
456 If the value is a COLOR name, then only the `cursor-color' attribute will be
457 affected. If the value is a cursor TYPE (one of: box, hollow, bar, or hbar),
458 then only the `cursor-type' property will be affected. If the value is
459 a cons (TYPE . COLOR), then both properties are affected."
460 :initialize 'custom-initialize-default
461 :type '(choice
462 (color :tag "Color")
463 (choice :tag "Type"
464 (const :tag "Filled box" box)
465 (const :tag "Vertical bar" bar)
466 (const :tag "Horizontal bar" hbar)
467 (const :tag "Hollow box" hollow))
468 (cons :tag "Color and Type"
469 (choice :tag "Type"
470 (const :tag "Filled box" box)
471 (const :tag "Vertical bar" bar)
472 (const :tag "Horizontal bar" hbar)
473 (const :tag "Hollow box" hollow))
474 (color :tag "Color")))
475 :group 'cua)
477 (defcustom cua-read-only-cursor-color "darkgreen"
478 "*Cursor color used in read-only buffers, if non-nil.
479 Only used when `cua-enable-cursor-indications' is non-nil.
481 If the value is a COLOR name, then only the `cursor-color' attribute will be
482 affected. If the value is a cursor TYPE (one of: box, hollow, bar, or hbar),
483 then only the `cursor-type' property will be affected. If the value is
484 a cons (TYPE . COLOR), then both properties are affected."
485 :type '(choice
486 (color :tag "Color")
487 (choice :tag "Type"
488 (const :tag "Filled box" box)
489 (const :tag "Vertical bar" bar)
490 (const :tag "Horizontal bar" hbar)
491 (const :tag "Hollow box" hollow))
492 (cons :tag "Color and Type"
493 (choice :tag "Type"
494 (const :tag "Filled box" box)
495 (const :tag "Vertical bar" bar)
496 (const :tag "Horizontal bar" hbar)
497 (const :tag "Hollow box" hollow))
498 (color :tag "Color")))
499 :group 'cua)
501 (defcustom cua-overwrite-cursor-color "yellow"
502 "*Cursor color used when overwrite mode is set, if non-nil.
503 Only used when `cua-enable-cursor-indications' is non-nil.
505 If the value is a COLOR name, then only the `cursor-color' attribute will be
506 affected. If the value is a cursor TYPE (one of: box, hollow, bar, or hbar),
507 then only the `cursor-type' property will be affected. If the value is
508 a cons (TYPE . COLOR), then both properties are affected."
509 :type '(choice
510 (color :tag "Color")
511 (choice :tag "Type"
512 (const :tag "Filled box" box)
513 (const :tag "Vertical bar" bar)
514 (const :tag "Horizontal bar" hbar)
515 (const :tag "Hollow box" hollow))
516 (cons :tag "Color and Type"
517 (choice :tag "Type"
518 (const :tag "Filled box" box)
519 (const :tag "Vertical bar" bar)
520 (const :tag "Horizontal bar" hbar)
521 (const :tag "Hollow box" hollow))
522 (color :tag "Color")))
523 :group 'cua)
525 (defcustom cua-global-mark-cursor-color "cyan"
526 "*Indication for active global mark.
527 Will change cursor color to specified color if string.
528 Only used when `cua-enable-cursor-indications' is non-nil.
530 If the value is a COLOR name, then only the `cursor-color' attribute will be
531 affected. If the value is a cursor TYPE (one of: box, hollow, bar, or hbar),
532 then only the `cursor-type' property will be affected. If the value is
533 a cons (TYPE . COLOR), then both properties are affected."
534 :type '(choice
535 (color :tag "Color")
536 (choice :tag "Type"
537 (const :tag "Filled box" box)
538 (const :tag "Vertical bar" bar)
539 (const :tag "Horizontal bar" hbar)
540 (const :tag "Hollow box" hollow))
541 (cons :tag "Color and Type"
542 (choice :tag "Type"
543 (const :tag "Filled box" box)
544 (const :tag "Vertical bar" bar)
545 (const :tag "Horizontal bar" hbar)
546 (const :tag "Hollow box" hollow))
547 (color :tag "Color")))
548 :group 'cua)
551 ;;; Rectangle support is in cua-rect.el
553 (autoload 'cua-set-rectangle-mark "cua-rect" nil t nil)
555 ;; Stub definitions until it is loaded
557 (when (not (featurep 'cua-rect))
558 (defvar cua--rectangle)
559 (setq cua--rectangle nil)
560 (defvar cua--last-killed-rectangle)
561 (setq cua--last-killed-rectangle nil))
565 ;;; Global Mark support is in cua-gmrk.el
567 (autoload 'cua-toggle-global-mark "cua-gmrk" nil t nil)
569 ;; Stub definitions until cua-gmrk.el is loaded
571 (when (not (featurep 'cua-gmrk))
572 (defvar cua--global-mark-active)
573 (setq cua--global-mark-active nil))
576 (provide 'cua-base)
578 (eval-when-compile
579 (require 'cua-rect)
580 (require 'cua-gmrk)
584 ;;; Low-level Interface
586 (defvar cua-inhibit-cua-keys nil
587 "Buffer-local variable that may disable the CUA keymappings.")
588 (make-variable-buffer-local 'cua-inhibit-cua-keys)
590 ;;; Aux. variables
592 ;; Current region was started using cua-set-mark.
593 (defvar cua--explicit-region-start nil)
594 (make-variable-buffer-local 'cua--explicit-region-start)
596 ;; Latest region was started using shifted movement command.
597 (defvar cua--last-region-shifted nil)
599 ;; buffer + point prior to current command when rectangle is active
600 ;; checked in post-command hook to see if point was moved
601 (defvar cua--buffer-and-point-before-command nil)
603 ;; status string for mode line indications
604 (defvar cua--status-string nil)
605 (make-variable-buffer-local 'cua--status-string)
607 (defvar cua--debug nil)
610 ;;; Prefix key override mechanism
612 ;; The prefix override (when mark-active) operates in three substates:
613 ;; [1] Before using a prefix key
614 ;; [2] Immediately after using a prefix key
615 ;; [3] A fraction of a second later
617 ;; In state [1], the cua--prefix-override-keymap is active.
618 ;; This keymap binds the C-x and C-c prefix keys to the
619 ;; cua--prefix-override-handler function.
621 ;; When a prefix key is typed in state [1], cua--prefix-override-handler
622 ;; will push back the keys already read to the event queue. If input is
623 ;; pending, it changes directly to state [3]. Otherwise, a short timer [T]
624 ;; is started, and it changes to state [2].
626 ;; In state [2], the cua--prefix-override-keymap is inactive. Instead the
627 ;; cua--prefix-repeat-keymap is active. This keymap binds C-c C-c and C-x
628 ;; C-x to the cua--prefix-repeat-handler function.
630 ;; If the prefix key is repeated in state [2], cua--prefix-repeat-handler
631 ;; will cancel [T], back the keys already read (except for the second prefix
632 ;; keys) to the event queue, and changes to state [3].
634 ;; The basic cua--cua-keys-keymap binds [C-x timeout] to kill-region and
635 ;; [C-c timeout] to copy-region-as-kill, so if [T] times out in state [2],
636 ;; the cua--prefix-override-timeout function will push a `timeout' event on
637 ;; the event queue, and changes to state [3].
639 ;; In state [3] both cua--prefix-override-keymap and cua--prefix-repeat-keymap
640 ;; are inactive, so the timeout in cua-global-keymap binding is used, or the
641 ;; normal prefix key binding from the global or local map will be used.
643 ;; The pre-command hook (executed as a consequence of the timeout or normal
644 ;; prefix key binding) will cancel [T] and change from state [3] back to
645 ;; state [1]. So cua--prefix-override-handler and cua--prefix-repeat-handler
646 ;; are always called with state reset to [1]!
648 ;; State [1] is recognized by cua--prefix-override-timer is nil,
649 ;; state [2] is recognized by cua--prefix-override-timer is a timer, and
650 ;; state [3] is recognized by cua--prefix-override-timer is t.
652 (defvar cua--prefix-override-timer nil)
653 (defvar cua--prefix-override-length nil)
655 (defun cua--prefix-override-replay (arg repeat)
656 (let* ((keys (this-command-keys))
657 (i (length keys))
658 (key (aref keys (1- i))))
659 (setq cua--prefix-override-length (- i repeat))
660 (setq cua--prefix-override-timer
662 ;; In state [2], change to state [3]
663 (> repeat 0)
664 ;; In state [1], change directly to state [3]
665 (and cua-check-pending-input (input-pending-p))
666 ;; In state [1], [T] disabled, so change to state [3]
667 (not (numberp cua-prefix-override-inhibit-delay))
668 (<= cua-prefix-override-inhibit-delay 0)
669 ;; In state [1], start [T] and change to state [2]
670 (run-with-timer cua-prefix-override-inhibit-delay nil
671 'cua--prefix-override-timeout)))
672 ;; Don't record this command
673 (setq this-command last-command)
674 ;; Restore the prefix arg
675 (setq prefix-arg arg)
676 (reset-this-command-lengths)
677 ;; Push the key back on the event queue
678 (setq unread-command-events (cons key unread-command-events))))
680 (defun cua--prefix-override-handler (arg)
681 "Start timer waiting for prefix key to be followed by another key.
682 Repeating prefix key when region is active works as a single prefix key."
683 (interactive "P")
684 (cua--prefix-override-replay arg 0))
686 (defun cua--prefix-repeat-handler (arg)
687 "Repeating prefix key when region is active works as a single prefix key."
688 (interactive "P")
689 (cua--prefix-override-replay arg 1))
691 (defun cua--prefix-copy-handler (arg)
692 "Copy region/rectangle, then replay last key."
693 (interactive "P")
694 (if cua--rectangle
695 (cua-copy-rectangle arg)
696 (cua-copy-region arg))
697 (let ((keys (this-single-command-keys)))
698 (setq unread-command-events
699 (cons (aref keys (1- (length keys))) unread-command-events))))
701 (defun cua--prefix-cut-handler (arg)
702 "Cut region/rectangle, then replay last key."
703 (interactive "P")
704 (if cua--rectangle
705 (cua-cut-rectangle arg)
706 (cua-cut-region arg))
707 (let ((keys (this-single-command-keys)))
708 (setq unread-command-events
709 (cons (aref keys (1- (length keys))) unread-command-events))))
711 (defun cua--prefix-override-timeout ()
712 (setq cua--prefix-override-timer t)
713 (when (= (length (this-command-keys)) cua--prefix-override-length)
714 (setq unread-command-events (cons 'timeout unread-command-events))
715 (if prefix-arg
716 (reset-this-command-lengths)
717 (setq overriding-terminal-local-map nil))
718 (cua--select-keymaps)))
721 ;;; Aux. functions
723 (defun cua--fallback ()
724 ;; Execute original command
725 (setq this-command this-original-command)
726 (call-interactively this-command))
728 (defun cua--keep-active ()
729 (setq mark-active t
730 deactivate-mark nil))
732 (defun cua--deactivate (&optional now)
733 (setq cua--explicit-region-start nil)
734 (if (not now)
735 (setq deactivate-mark t)
736 (setq mark-active nil)
737 (run-hooks 'deactivate-mark-hook)))
740 ;; The current register prefix
741 (defvar cua--register nil)
743 (defun cua--prefix-arg (arg)
744 (setq cua--register
745 (and cua-enable-register-prefix
746 (integerp arg) (>= arg 0) (< arg 10)
747 (let* ((prefix (aref (this-command-keys) 0))
748 (ctrl-u-prefix (and (integerp prefix)
749 (= prefix ?\C-u))))
750 (cond
751 ((eq cua-enable-register-prefix 'not-ctrl-u)
752 (not ctrl-u-prefix))
753 ((eq cua-enable-register-prefix 'ctrl-u-only)
754 ctrl-u-prefix)
755 (t t)))
756 (+ arg ?0)))
757 (if cua--register nil arg))
760 ;;; Region specific commands
762 (defvar cua--last-deleted-region-pos nil)
763 (defvar cua--last-deleted-region-text nil)
765 (defun cua-delete-region ()
766 "Delete the active region.
767 Save a copy in register 0 if `cua-delete-copy-to-register-0' is non-nil."
768 (interactive)
769 (let ((start (mark)) (end (point)))
770 (or (<= start end)
771 (setq start (prog1 end (setq end start))))
772 (setq cua--last-deleted-region-text (filter-buffer-substring start end))
773 (if cua-delete-copy-to-register-0
774 (set-register ?0 cua--last-deleted-region-text))
775 (delete-region start end)
776 (setq cua--last-deleted-region-pos
777 (cons (current-buffer)
778 (and (consp buffer-undo-list)
779 (car buffer-undo-list))))
780 (cua--deactivate)
781 (/= start end)))
783 (defun cua-replace-region ()
784 "Replace the active region with the character you type."
785 (interactive)
786 (let ((not-empty (cua-delete-region)))
787 (unless (eq this-original-command this-command)
788 (let ((overwrite-mode
789 (and overwrite-mode
790 not-empty
791 (not (eq this-original-command 'self-insert-command)))))
792 (cua--fallback)))))
794 (defun cua-copy-region (arg)
795 "Copy the region to the kill ring.
796 With numeric prefix arg, copy to register 0-9 instead."
797 (interactive "P")
798 (setq arg (cua--prefix-arg arg))
799 (setq cua--last-killed-rectangle nil)
800 (let ((start (mark)) (end (point)))
801 (or (<= start end)
802 (setq start (prog1 end (setq end start))))
803 (cond
804 (cua--register
805 (copy-to-register cua--register start end nil))
806 ((eq this-original-command 'clipboard-kill-ring-save)
807 (clipboard-kill-ring-save start end))
809 (copy-region-as-kill start end)))
810 (if cua-keep-region-after-copy
811 (cua--keep-active)
812 (cua--deactivate))))
814 (defun cua-cut-region (arg)
815 "Cut the region and copy to the kill ring.
816 With numeric prefix arg, copy to register 0-9 instead."
817 (interactive "P")
818 (setq cua--last-killed-rectangle nil)
819 (if buffer-read-only
820 (cua-copy-region arg)
821 (setq arg (cua--prefix-arg arg))
822 (let ((start (mark)) (end (point)))
823 (or (<= start end)
824 (setq start (prog1 end (setq end start))))
825 (cond
826 (cua--register
827 (copy-to-register cua--register start end t))
828 ((eq this-original-command 'clipboard-kill-region)
829 (clipboard-kill-region start end))
831 (kill-region start end))))
832 (cua--deactivate)))
834 ;;; Generic commands for regions, rectangles, and global marks
836 (defun cua-cancel ()
837 "Cancel the active region, rectangle, or global mark."
838 (interactive)
839 (setq mark-active nil)
840 (setq cua--explicit-region-start nil)
841 (if (fboundp 'cua--cancel-rectangle)
842 (cua--cancel-rectangle)))
844 (defun cua-paste (arg)
845 "Paste last cut or copied region or rectangle.
846 An active region is deleted before executing the command.
847 With numeric prefix arg, paste from register 0-9 instead.
848 If global mark is active, copy from register or one character."
849 (interactive "P")
850 (setq arg (cua--prefix-arg arg))
851 (let ((regtxt (and cua--register (get-register cua--register)))
852 (count (prefix-numeric-value arg))
853 paste-column paste-lines)
854 (cond
855 ((and cua--register (not regtxt))
856 (message "Nothing in register %c" cua--register))
857 (cua--global-mark-active
858 (if regtxt
859 (cua--insert-at-global-mark regtxt)
860 (when (not (eobp))
861 (cua--insert-at-global-mark (filter-buffer-substring (point) (+ (point) count)))
862 (forward-char count))))
863 (buffer-read-only
864 (message "Cannot paste into a read-only buffer"))
866 ;; Must save register here, since delete may override reg 0.
867 (if mark-active
868 ;; Before a yank command, make sure we don't yank
869 ;; the same region that we are going to delete.
870 ;; That would make yank a no-op.
871 (if cua--rectangle
872 (progn
873 (goto-char (min (mark) (point)))
874 (setq paste-column (cua--rectangle-left))
875 (setq paste-lines (cua--delete-rectangle))
876 (if (= paste-lines 1)
877 (setq paste-lines nil))) ;; paste all
878 (if (string= (filter-buffer-substring (point) (mark))
879 (car kill-ring))
880 (current-kill 1))
881 (cua-delete-region)))
882 (cond
883 (regtxt
884 (cond
885 ((consp regtxt) (cua--insert-rectangle regtxt))
886 ((stringp regtxt) (insert-for-yank regtxt))
887 (t (message "Unknown data in register %c" cua--register))))
888 ((and cua--last-killed-rectangle
889 (eq (and kill-ring (car kill-ring)) (car cua--last-killed-rectangle)))
890 (let ((pt (point)))
891 (when (not (eq buffer-undo-list t))
892 (setq this-command 'cua--paste-rectangle)
893 (undo-boundary)
894 (setq buffer-undo-list (cons pt buffer-undo-list)))
895 (cua--insert-rectangle (cdr cua--last-killed-rectangle)
896 nil paste-column paste-lines)
897 (if arg (goto-char pt))))
898 ((eq this-original-command 'clipboard-yank)
899 (clipboard-yank))
900 (t (yank arg)))))))
902 (defun cua-paste-pop (arg)
903 "Replace a just-pasted text or rectangle with a different text.
904 See `yank-pop' for details."
905 (interactive "P")
906 (if (eq last-command 'cua--paste-rectangle)
907 (progn
908 (undo)
909 (yank arg))
910 (yank-pop (prefix-numeric-value arg))))
912 (defun cua-exchange-point-and-mark (arg)
913 "Exchanges point and mark, but don't activate the mark.
914 Activates the mark if a prefix argument is given."
915 (interactive "P")
916 (if arg
917 (setq mark-active t)
918 (let (mark-active)
919 (exchange-point-and-mark)
920 (if cua--rectangle
921 (cua--rectangle-corner 0)))))
923 ;; Typed text that replaced the highlighted region.
924 (defvar cua--repeat-replace-text nil)
926 (defun cua-repeat-replace-region (arg)
927 "Repeat replacing text of highlighted region with typed text.
928 Searches for the next stretch of text identical to the region last
929 replaced by typing text over it and replaces it with the same stretch
930 of text."
931 (interactive "P")
932 (when cua--last-deleted-region-pos
933 (save-excursion
934 (save-restriction
935 (set-buffer (car cua--last-deleted-region-pos))
936 (widen)
937 ;; Find the text that replaced the region via the undo list.
938 (let ((ul buffer-undo-list)
939 (elt (cdr cua--last-deleted-region-pos))
940 u s e)
941 (when elt
942 (while (consp ul)
943 (setq u (car ul) ul (cdr ul))
944 (cond
945 ((eq u elt) ;; got it
946 (setq ul nil))
947 ((and (consp u) (integerp (car u)) (integerp (cdr u)))
948 (if (and s (= (cdr u) s))
949 (setq s (car u))
950 (setq s (car u) e (cdr u)))))))
951 (setq cua--repeat-replace-text
952 (cond ((and s e (<= s e) (= s (mark t)))
953 (filter-buffer-substring s e nil t))
954 ((and (null s) (eq u elt)) ;; nothing inserted
957 (message "Cannot locate replacement text")
958 nil))))))
959 (setq cua--last-deleted-region-pos nil))
960 (if (and cua--last-deleted-region-text
961 cua--repeat-replace-text
962 (search-forward cua--last-deleted-region-text nil t nil))
963 (replace-match cua--repeat-replace-text arg t)))
965 (defun cua-help-for-region (&optional help)
966 "Show region specific help in echo area."
967 (interactive)
968 (message
969 (concat (if help "C-?:help " "")
970 "C-z:undo C-x:cut C-c:copy C-v:paste S-ret:rect")))
973 ;;; Shift activated / extended region
975 (defun cua-set-mark (&optional arg)
976 "Set mark at where point is, clear mark, or jump to mark.
978 With no prefix argument, clear mark if already set. Otherwise, set
979 mark, and push old mark position on local mark ring; also push mark on
980 global mark ring if last mark was set in another buffer.
982 With argument, jump to mark, and pop a new position for mark off
983 the local mark ring \(this does not affect the global mark ring\).
984 Use \\[pop-global-mark] to jump to a mark off the global mark ring
985 \(see `pop-global-mark'\).
987 Repeating the command without the prefix jumps to the next position
988 off the local \(or global\) mark ring.
990 With a double \\[universal-argument] prefix argument, unconditionally set mark."
991 (interactive "P")
992 (cond
993 ((and (consp arg) (> (prefix-numeric-value arg) 4))
994 (push-mark-command nil))
995 ((eq last-command 'pop-to-mark-command)
996 (setq this-command 'pop-to-mark-command)
997 (pop-to-mark-command))
998 ((and (eq last-command 'pop-global-mark) (not arg))
999 (setq this-command 'pop-global-mark)
1000 (pop-global-mark))
1001 (arg
1002 (setq this-command 'pop-to-mark-command)
1003 (pop-to-mark-command))
1004 (mark-active
1005 (cua--deactivate)
1006 (message "Mark Cleared"))
1008 (push-mark-command nil nil)
1009 (setq cua--explicit-region-start t)
1010 (setq cua--last-region-shifted nil)
1011 (if cua-enable-region-auto-help
1012 (cua-help-for-region t)))))
1014 ;;; Scrolling commands which does not signal errors at top/bottom
1015 ;;; of buffer at first key-press (instead moves to top/bottom
1016 ;;; of buffer).
1018 (defun cua-scroll-up (&optional arg)
1019 "Scroll text of current window upward ARG lines; or near full screen if no ARG.
1020 If window cannot be scrolled further, move cursor to bottom line instead.
1021 A near full screen is `next-screen-context-lines' less than a full screen.
1022 Negative ARG means scroll downward.
1023 If ARG is the atom `-', scroll downward by nearly full screen."
1024 (interactive "P")
1025 (cond
1026 ((eq arg '-) (cua-scroll-down nil))
1027 ((< (prefix-numeric-value arg) 0)
1028 (cua-scroll-down (- (prefix-numeric-value arg))))
1029 ((eobp)
1030 (scroll-up arg)) ; signal error
1032 (condition-case nil
1033 (scroll-up arg)
1034 (end-of-buffer (goto-char (point-max)))))))
1036 (put 'cua-scroll-up 'CUA 'move)
1038 (defun cua-scroll-down (&optional arg)
1039 "Scroll text of current window downward ARG lines; or near full screen if no ARG.
1040 If window cannot be scrolled further, move cursor to top line instead.
1041 A near full screen is `next-screen-context-lines' less than a full screen.
1042 Negative ARG means scroll upward.
1043 If ARG is the atom `-', scroll upward by nearly full screen."
1044 (interactive "P")
1045 (cond
1046 ((eq arg '-) (cua-scroll-up nil))
1047 ((< (prefix-numeric-value arg) 0)
1048 (cua-scroll-up (- (prefix-numeric-value arg))))
1049 ((bobp)
1050 (scroll-down arg)) ; signal error
1052 (condition-case nil
1053 (scroll-down arg)
1054 (beginning-of-buffer (goto-char (point-min)))))))
1056 (put 'cua-scroll-down 'CUA 'move)
1058 ;;; Cursor indications
1060 (defun cua--update-indications ()
1061 (let* ((cursor
1062 (cond
1063 ((and cua--global-mark-active
1064 cua-global-mark-cursor-color)
1065 cua-global-mark-cursor-color)
1066 ((and buffer-read-only
1067 cua-read-only-cursor-color)
1068 cua-read-only-cursor-color)
1069 ((and cua-overwrite-cursor-color overwrite-mode)
1070 cua-overwrite-cursor-color)
1071 (t cua-normal-cursor-color)))
1072 (color (if (consp cursor) (cdr cursor) cursor))
1073 (type (if (consp cursor) (car cursor) cursor)))
1074 (if (and color
1075 (stringp color)
1076 (not (equal color (frame-parameter nil 'cursor-color))))
1077 (set-cursor-color color))
1078 (if (and type
1079 (symbolp type)
1080 (not (eq type default-cursor-type)))
1081 (setq default-cursor-type type))))
1084 ;;; Pre-command hook
1086 (defun cua--pre-command-handler-1 ()
1087 (let ((movement (eq (get this-command 'CUA) 'move)))
1089 ;; Cancel prefix key timeout if user enters another key.
1090 (when cua--prefix-override-timer
1091 (if (timerp cua--prefix-override-timer)
1092 (cancel-timer cua--prefix-override-timer))
1093 (setq cua--prefix-override-timer nil))
1095 ;; Handle shifted cursor keys and other movement commands.
1096 ;; If region is not active, region is activated if key is shifted.
1097 ;; If region is active, region is cancelled if key is unshifted (and region not started with C-SPC).
1098 ;; If rectangle is active, expand rectangle in specified direction and ignore the movement.
1099 (if movement
1100 (cond
1101 ((if window-system
1102 (memq 'shift (event-modifiers
1103 (aref (this-single-command-raw-keys) 0)))
1105 (memq 'shift (event-modifiers
1106 (aref (this-single-command-keys) 0)))
1107 ;; See if raw escape sequence maps to a shifted event, e.g. S-up or C-S-home.
1108 (and (boundp 'function-key-map)
1109 function-key-map
1110 (let ((ev (lookup-key function-key-map
1111 (this-single-command-raw-keys))))
1112 (and (vector ev)
1113 (symbolp (setq ev (aref ev 0)))
1114 (string-match "S-" (symbol-name ev)))))))
1115 (unless mark-active
1116 (push-mark-command nil t))
1117 (setq cua--last-region-shifted t)
1118 (setq cua--explicit-region-start nil))
1119 ((or cua--explicit-region-start cua--rectangle)
1120 (unless mark-active
1121 (push-mark-command nil nil)))
1123 ;; If we set mark-active to nil here, the region highlight will not be
1124 ;; removed by the direct_output_ commands.
1125 (setq deactivate-mark t)))
1127 ;; Handle delete-selection property on other commands
1128 (if (and mark-active (not deactivate-mark))
1129 (let* ((ds (or (get this-command 'delete-selection)
1130 (get this-command 'pending-delete)))
1131 (nc (cond
1132 ((not ds) nil)
1133 ((eq ds 'yank)
1134 'cua-paste)
1135 ((eq ds 'kill)
1136 (if cua--rectangle
1137 'cua-copy-rectangle
1138 'cua-copy-region))
1139 ((eq ds 'supersede)
1140 (if cua--rectangle
1141 'cua-delete-rectangle
1142 'cua-delete-region))
1144 (if cua--rectangle
1145 'cua-delete-rectangle ;; replace?
1146 'cua-replace-region)))))
1147 (if nc
1148 (setq this-original-command this-command
1149 this-command nc)))))
1151 ;; Detect extension of rectangles by mouse or other movement
1152 (setq cua--buffer-and-point-before-command
1153 (if cua--rectangle (cons (current-buffer) (point))))))
1155 (defun cua--pre-command-handler ()
1156 (when cua-mode
1157 (condition-case nil
1158 (cua--pre-command-handler-1)
1159 (error nil))))
1161 ;;; Post-command hook
1163 (defun cua--post-command-handler-1 ()
1164 (when cua--global-mark-active
1165 (cua--global-mark-post-command))
1166 (when (fboundp 'cua--rectangle-post-command)
1167 (cua--rectangle-post-command))
1168 (setq cua--buffer-and-point-before-command nil)
1169 (if (or (not mark-active) deactivate-mark)
1170 (setq cua--explicit-region-start nil))
1172 ;; Debugging
1173 (if cua--debug
1174 (cond
1175 (cua--rectangle (cua--rectangle-assert))
1176 (mark-active (message "Mark=%d Point=%d Expl=%s"
1177 (mark t) (point) cua--explicit-region-start))))
1179 ;; Disable transient-mark-mode if rectangle active in current buffer.
1180 (if (not (window-minibuffer-p (selected-window)))
1181 (setq transient-mark-mode (and (not cua--rectangle)
1182 (if cua-highlight-region-shift-only
1183 (not cua--explicit-region-start)
1184 t))))
1185 (if cua-enable-cursor-indications
1186 (cua--update-indications))
1188 (cua--select-keymaps))
1190 (defun cua--post-command-handler ()
1191 (when cua-mode
1192 (condition-case nil
1193 (cua--post-command-handler-1)
1194 (error nil))))
1197 ;;; Keymaps
1199 ;; Cached value of actual cua-rectangle-modifier-key
1200 (defvar cua--rectangle-modifier-key 'meta)
1202 (defun cua--M/H-key (map key fct)
1203 ;; bind H-KEY or M-KEY to FCT in MAP
1204 (unless (listp key) (setq key (list key)))
1205 (define-key map (vector (cons cua--rectangle-modifier-key key)) fct))
1207 (defun cua--self-insert-char-p (def)
1208 ;; Return DEF if current key sequence is self-inserting in
1209 ;; global-map.
1210 (if (memq (global-key-binding (this-single-command-keys))
1211 '(self-insert-command self-insert-iso))
1212 def nil))
1214 (defvar cua-global-keymap (make-sparse-keymap)
1215 "Global keymap for cua-mode; users may add to this keymap.")
1217 (defvar cua--cua-keys-keymap (make-sparse-keymap))
1218 (defvar cua--prefix-override-keymap (make-sparse-keymap))
1219 (defvar cua--prefix-repeat-keymap (make-sparse-keymap))
1220 (defvar cua--global-mark-keymap (make-sparse-keymap)) ; Initalized when cua-gmrk.el is loaded
1221 (defvar cua--rectangle-keymap (make-sparse-keymap)) ; Initalized when cua-rect.el is loaded
1222 (defvar cua--region-keymap (make-sparse-keymap))
1224 (defvar cua--ena-cua-keys-keymap nil)
1225 (defvar cua--ena-prefix-override-keymap nil)
1226 (defvar cua--ena-prefix-repeat-keymap nil)
1227 (defvar cua--ena-region-keymap nil)
1228 (defvar cua--ena-global-mark-keymap nil)
1230 (defvar cua--keymap-alist
1231 `((cua--ena-prefix-override-keymap . ,cua--prefix-override-keymap)
1232 (cua--ena-prefix-repeat-keymap . ,cua--prefix-repeat-keymap)
1233 (cua--ena-cua-keys-keymap . ,cua--cua-keys-keymap)
1234 (cua--ena-global-mark-keymap . ,cua--global-mark-keymap)
1235 (cua--rectangle . ,cua--rectangle-keymap)
1236 (cua--ena-region-keymap . ,cua--region-keymap)
1237 (cua-mode . ,cua-global-keymap)))
1239 (defun cua--select-keymaps ()
1240 ;; Setup conditions for selecting the proper keymaps in cua--keymap-alist.
1241 (setq cua--ena-region-keymap
1242 (and mark-active (not deactivate-mark)))
1243 (setq cua--ena-prefix-override-keymap
1244 (and cua--ena-region-keymap
1245 cua-enable-cua-keys
1246 (not cua-inhibit-cua-keys)
1247 (or (eq cua-enable-cua-keys t)
1248 (not cua--explicit-region-start))
1249 (not executing-kbd-macro)
1250 (not cua--prefix-override-timer)))
1251 (setq cua--ena-prefix-repeat-keymap
1252 (and cua--ena-region-keymap
1253 (or (timerp cua--prefix-override-timer)
1254 (eq cua--prefix-override-timer 'shift))))
1255 (setq cua--ena-cua-keys-keymap
1256 (and cua-enable-cua-keys
1257 (not cua-inhibit-cua-keys)
1258 (or (eq cua-enable-cua-keys t)
1259 cua--last-region-shifted)))
1260 (setq cua--ena-global-mark-keymap
1261 (and cua--global-mark-active
1262 (not (window-minibuffer-p)))))
1264 (defvar cua--keymaps-initalized nil)
1266 (defun cua--shift-control-prefix (prefix arg)
1267 ;; handle S-C-x and S-C-c by emulating the fast double prefix function.
1268 ;; Don't record this command
1269 (setq this-command last-command)
1270 ;; Restore the prefix arg
1271 (setq prefix-arg arg)
1272 (reset-this-command-lengths)
1273 ;; Activate the cua--prefix-repeat-keymap
1274 (setq cua--prefix-override-timer 'shift)
1275 ;; Push duplicate keys back on the event queue
1276 (setq unread-command-events (cons prefix (cons prefix unread-command-events))))
1278 (defun cua--shift-control-c-prefix (arg)
1279 (interactive "P")
1280 (cua--shift-control-prefix ?\C-c arg))
1282 (defun cua--shift-control-x-prefix (arg)
1283 (interactive "P")
1284 (cua--shift-control-prefix ?\C-x arg))
1286 (defun cua--init-keymaps ()
1287 ;; Cache actual rectangle modifier key.
1288 (setq cua--rectangle-modifier-key
1289 (if (and cua-rectangle-modifier-key
1290 (memq window-system '(x)))
1291 cua-rectangle-modifier-key
1292 'meta))
1293 ;; C-return always toggles rectangle mark
1294 (define-key cua-global-keymap cua-rectangle-mark-key 'cua-set-rectangle-mark)
1295 (unless (eq cua--rectangle-modifier-key 'meta)
1296 (cua--M/H-key cua-global-keymap ?\s 'cua-set-rectangle-mark)
1297 (define-key cua-global-keymap
1298 (vector (list cua--rectangle-modifier-key 'mouse-1)) 'cua-mouse-set-rectangle-mark))
1300 (define-key cua-global-keymap [(shift control ?\s)] 'cua-toggle-global-mark)
1302 ;; replace region with rectangle or element on kill ring
1303 (define-key cua-global-keymap [remap yank] 'cua-paste)
1304 (define-key cua-global-keymap [remap clipboard-yank] 'cua-paste)
1305 ;; replace current yank with previous kill ring element
1306 (define-key cua-global-keymap [remap yank-pop] 'cua-paste-pop)
1307 ;; set mark
1308 (define-key cua-global-keymap [remap set-mark-command] 'cua-set-mark)
1310 ;; scrolling
1311 (define-key cua-global-keymap [remap scroll-up] 'cua-scroll-up)
1312 (define-key cua-global-keymap [remap scroll-down] 'cua-scroll-down)
1314 (define-key cua--cua-keys-keymap [(control x) timeout] 'kill-region)
1315 (define-key cua--cua-keys-keymap [(control c) timeout] 'copy-region-as-kill)
1316 (define-key cua--cua-keys-keymap [(control z)] 'undo)
1317 (define-key cua--cua-keys-keymap [(control v)] 'yank)
1318 (define-key cua--cua-keys-keymap [(meta v)] 'cua-repeat-replace-region)
1319 (define-key cua--cua-keys-keymap [remap exchange-point-and-mark] 'cua-exchange-point-and-mark)
1321 (define-key cua--prefix-override-keymap [(control x)] 'cua--prefix-override-handler)
1322 (define-key cua--prefix-override-keymap [(control c)] 'cua--prefix-override-handler)
1324 (define-key cua--prefix-repeat-keymap [(control x) (control x)] 'cua--prefix-repeat-handler)
1325 (define-key cua--prefix-repeat-keymap [(control x) up] 'cua--prefix-cut-handler)
1326 (define-key cua--prefix-repeat-keymap [(control x) down] 'cua--prefix-cut-handler)
1327 (define-key cua--prefix-repeat-keymap [(control x) left] 'cua--prefix-cut-handler)
1328 (define-key cua--prefix-repeat-keymap [(control x) right] 'cua--prefix-cut-handler)
1329 (define-key cua--prefix-repeat-keymap [(control c) (control c)] 'cua--prefix-repeat-handler)
1330 (define-key cua--prefix-repeat-keymap [(control c) up] 'cua--prefix-copy-handler)
1331 (define-key cua--prefix-repeat-keymap [(control c) down] 'cua--prefix-copy-handler)
1332 (define-key cua--prefix-repeat-keymap [(control c) left] 'cua--prefix-copy-handler)
1333 (define-key cua--prefix-repeat-keymap [(control c) right] 'cua--prefix-copy-handler)
1335 ;; Enable shifted fallbacks for C-x and C-c when region is active
1336 (define-key cua--region-keymap [(shift control x)] 'cua--shift-control-x-prefix)
1337 (define-key cua--region-keymap [(shift control c)] 'cua--shift-control-c-prefix)
1339 ;; replace current region
1340 (define-key cua--region-keymap [remap self-insert-command] 'cua-replace-region)
1341 (define-key cua--region-keymap [remap self-insert-iso] 'cua-replace-region)
1342 (define-key cua--region-keymap [remap insert-register] 'cua-replace-region)
1343 (define-key cua--region-keymap [remap newline-and-indent] 'cua-replace-region)
1344 (define-key cua--region-keymap [remap newline] 'cua-replace-region)
1345 (define-key cua--region-keymap [remap open-line] 'cua-replace-region)
1346 ;; delete current region
1347 (define-key cua--region-keymap [remap delete-backward-char] 'cua-delete-region)
1348 (define-key cua--region-keymap [remap backward-delete-char] 'cua-delete-region)
1349 (define-key cua--region-keymap [remap backward-delete-char-untabify] 'cua-delete-region)
1350 (define-key cua--region-keymap [remap delete-char] 'cua-delete-region)
1351 ;; kill region
1352 (define-key cua--region-keymap [remap kill-region] 'cua-cut-region)
1353 (define-key cua--region-keymap [remap clipboard-kill-region] 'cua-cut-region)
1354 ;; copy region
1355 (define-key cua--region-keymap [remap copy-region-as-kill] 'cua-copy-region)
1356 (define-key cua--region-keymap [remap kill-ring-save] 'cua-copy-region)
1357 (define-key cua--region-keymap [remap clipboard-kill-ring-save] 'cua-copy-region)
1358 ;; cancel current region/rectangle
1359 (define-key cua--region-keymap [remap keyboard-escape-quit] 'cua-cancel)
1360 (define-key cua--region-keymap [remap keyboard-quit] 'cua-cancel)
1364 ;; Setup standard movement commands to be recognized by CUA.
1366 (dolist (cmd
1367 '(forward-char backward-char
1368 next-line previous-line
1369 forward-word backward-word
1370 end-of-line beginning-of-line
1371 move-end-of-line move-beginning-of-line
1372 end-of-buffer beginning-of-buffer
1373 scroll-up scroll-down
1374 up-list down-list backward-up-list
1375 end-of-defun beginning-of-defun
1376 forward-sexp backward-sexp
1377 forward-list backward-list
1378 forward-sentence backward-sentence
1379 forward-paragraph backward-paragraph))
1380 (put cmd 'CUA 'move))
1382 ;; State prior to enabling cua-mode
1383 ;; Value is a list with the following elements:
1384 ;; transient-mark-mode
1385 ;; delete-selection-mode
1386 ;; pc-selection-mode
1388 (defvar cua--saved-state nil)
1390 ;;;###autoload
1391 (define-minor-mode cua-mode
1392 "Toggle CUA key-binding mode.
1393 When enabled, using shifted movement keys will activate the
1394 region (and highlight the region using `transient-mark-mode'),
1395 and typed text replaces the active selection.
1397 Also when enabled, you can use C-z, C-x, C-c, and C-v to undo,
1398 cut, copy, and paste in addition to the normal Emacs bindings.
1399 The C-x and C-c keys only do cut and copy when the region is
1400 active, so in most cases, they do not conflict with the normal
1401 function of these prefix keys.
1403 If you really need to perform a command which starts with one of
1404 the prefix keys even when the region is active, you have three
1405 options:
1406 - press the prefix key twice very quickly (within 0.2 seconds),
1407 - press the prefix key and the following key within 0.2 seconds, or
1408 - use the SHIFT key with the prefix key, i.e. C-S-x or C-S-c.
1410 You can customize `cua-enable-cua-keys' to completely disable the
1411 CUA bindings, or `cua-prefix-override-inhibit-delay' to change
1412 the prefix fallback behavior.
1414 CUA mode manages Transient Mark mode internally. Trying to disable
1415 Transient Mark mode while CUA mode is enabled does not work; if you
1416 only want to highlight the region when it is selected using a
1417 shifted movement key, set `cua-highlight-region-shift-only'."
1418 :global t
1419 :group 'cua
1420 :set-after '(cua-enable-modeline-indications
1421 cua-rectangle-mark-key cua-rectangle-modifier-key)
1422 :require 'cua-base
1423 :link '(emacs-commentary-link "cua-base.el")
1424 (setq mark-even-if-inactive t)
1425 (setq highlight-nonselected-windows nil)
1427 (unless cua--keymaps-initalized
1428 (cua--init-keymaps)
1429 (setq cua--keymaps-initalized t))
1431 (if cua-mode
1432 (progn
1433 (add-hook 'pre-command-hook 'cua--pre-command-handler)
1434 (add-hook 'post-command-hook 'cua--post-command-handler)
1435 (if (and cua-enable-modeline-indications (not (assoc 'cua-mode minor-mode-alist)))
1436 (setq minor-mode-alist (cons '(cua-mode cua--status-string) minor-mode-alist)))
1437 (if cua-enable-cursor-indications
1438 (cua--update-indications)))
1440 (remove-hook 'pre-command-hook 'cua--pre-command-handler)
1441 (remove-hook 'post-command-hook 'cua--post-command-handler))
1443 (if (not cua-mode)
1444 (setq emulation-mode-map-alists (delq 'cua--keymap-alist emulation-mode-map-alists))
1445 (add-to-ordered-list 'emulation-mode-map-alists 'cua--keymap-alist 400)
1446 (cua--select-keymaps))
1448 (cond
1449 (cua-mode
1450 (setq cua--saved-state
1451 (list
1452 transient-mark-mode
1453 (and (boundp 'delete-selection-mode) delete-selection-mode)
1454 (and (boundp 'pc-selection-mode) pc-selection-mode)))
1455 (if (and (boundp 'delete-selection-mode) delete-selection-mode)
1456 (delete-selection-mode -1))
1457 (if (and (boundp 'pc-selection-mode) pc-selection-mode)
1458 (pc-selection-mode -1))
1459 (cua--deactivate)
1460 (setq transient-mark-mode (and cua-mode
1461 (if cua-highlight-region-shift-only
1462 (not cua--explicit-region-start)
1463 t))))
1464 (cua--saved-state
1465 (setq transient-mark-mode (car cua--saved-state))
1466 (if (nth 1 cua--saved-state)
1467 (delete-selection-mode 1))
1468 (if (nth 2 cua--saved-state)
1469 (pc-selection-mode 1))
1470 (if (interactive-p)
1471 (message "CUA mode disabled.%s%s%s%s"
1472 (if (nth 1 cua--saved-state) " Delete-Selection" "")
1473 (if (and (nth 1 cua--saved-state) (nth 2 cua--saved-state)) " and" "")
1474 (if (nth 2 cua--saved-state) " PC-Selection" "")
1475 (if (or (nth 1 cua--saved-state) (nth 2 cua--saved-state)) " enabled" "")))
1476 (setq cua--saved-state nil))))
1479 ;;;###autoload
1480 (defun cua-selection-mode (arg)
1481 "Enable CUA selection mode without the C-z/C-x/C-c/C-v bindings."
1482 (interactive "P")
1483 (setq-default cua-enable-cua-keys nil)
1484 (cua-mode arg))
1487 (defun cua-debug ()
1488 "Toggle CUA debugging."
1489 (interactive)
1490 (setq cua--debug (not cua--debug)))
1492 ;; Install run-time check for older versions of CUA-mode which does not
1493 ;; work with GNU Emacs version 22.1 and newer.
1495 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
1496 ;; provided the `CUA-mode' feature. Since this is no longer true,
1497 ;; we can warn the user if the `CUA-mode' feature is ever provided.
1499 ;;;###autoload (eval-after-load 'CUA-mode
1500 ;;;###autoload '(error (concat "\n\n"
1501 ;;;###autoload "CUA-mode is now part of the standard GNU Emacs distribution,\n"
1502 ;;;###autoload "so you may now enable and customize CUA via the Options menu.\n\n"
1503 ;;;###autoload "You have loaded an older version of CUA-mode which does\n"
1504 ;;;###autoload "not work correctly with this version of GNU Emacs.\n\n"
1505 ;;;###autoload (if user-init-file (concat
1506 ;;;###autoload "To correct this, remove the loading and customization of the\n"
1507 ;;;###autoload "old version from the " user-init-file " file.\n\n")))))
1509 (provide 'cua)
1511 ;;; arch-tag: 21fb6289-ba25-4fee-bfdc-f9fb351acf05
1512 ;;; cua-base.el ends here