Typo.
[bpt/emacs.git] / lisp / emulation / cua-base.el
1 ;;; cua-base.el --- emulate CUA key bindings
2
3 ;; Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
5
6 ;; Author: Kim F. Storm <storm@cua.dk>
7 ;; Keywords: keyboard emulation convenience cua
8
9 ;; This file is part of GNU Emacs.
10
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)
14 ;; any later version.
15
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.
20
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.
25
26
27 ;;; Commentary:
28
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.
33
34 ;; CUA style key bindings for cut and paste
35 ;; ----------------------------------------
36
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
43 ;;
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!!!
47 ;;
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!
54 ;;
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).
61 ;;
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
67 ;;
68 ;; This behaviour can be customized via the
69 ;; cua-prefix-override-inhibit-delay variable.
70
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].
74
75 ;; If you prefer to use the standard emacs cut, copy, paste, and undo
76 ;; bindings, customize cua-enable-cua-keys to nil.
77
78
79 ;; Typing text replaces the region
80 ;; -------------------------------
81
82 ;; When the region is active, i.e. highlighted, the text in region is
83 ;; replaced by the text you type.
84
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).
87
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.
94 ;;
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.
101
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.
105
106
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:
114 ;;
115 ;; (setq cua-normal-cursor-color "red")
116 ;; (setq cua-overwrite-cursor-color "yellow")
117 ;; (setq cua-read-only-cursor-color "green")
118 ;;
119
120 ;; CUA register support
121 ;; --------------------
122 ;; Emacs' standard register support is also based on a separate set of
123 ;; "register commands".
124 ;;
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].
129 ;;
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.
132 ;;
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].
137
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.
144 ;;
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).
154 ;;
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!
161 ;;
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!
169 ;;
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.
174 ;;
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.
178
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.
185 ;;
186 ;; [C-return] cancels the rectangle
187 ;; [C-space] activates the region bounded by the rectangle
188
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
198
199 ;; cua-mode's rectangle support also includes all the normal rectangle
200 ;; functions with easy access:
201 ;;
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.
229
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].
233
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.
253
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).
256
257 ;; [TAB] Indents the current line or rectangle to the column of the
258 ;; global mark.
259
260 ;;; Code:
261
262 ;;; Customization
263
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"))
273
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)
284
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)
293
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)
307
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))
312 :group 'cua)
313
314 (defcustom cua-keep-region-after-copy nil
315 "If non-nil, don't deselect the region after copying."
316 :type 'boolean
317 :group 'cua)
318
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))
323 :group 'cua)
324
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."
330 :type 'boolean
331 :group 'cua)
332
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))
345 :group 'cua)
346
347 (defcustom cua-delete-copy-to-register-0 t
348 "*If non-nil, save last deleted region or rectangle to register 0."
349 :type 'boolean
350 :group 'cua)
351
352 (defcustom cua-enable-region-auto-help nil
353 "*If non-nil, automatically show help for active region."
354 :type 'boolean
355 :group 'cua)
356
357 (defcustom cua-enable-modeline-indications nil
358 "*If non-nil, use minor-mode hook to show status in mode line."
359 :type 'boolean
360 :group 'cua)
361
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."
366 :type 'boolean
367 :group 'cua)
368
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."
376 :type 'boolean
377 :group 'cua)
378
379 ;;; Rectangle Customization
380
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."
386 :type 'boolean
387 :group 'cua)
388
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))
400 :group 'cua)
401
402 (defvar cua-global-keymap) ; forward
403 (defvar cua--region-keymap) ; forward
404
405 (defcustom cua-rectangle-mark-key [(control return)]
406 "Global key used to toggle the cua rectangle mark."
407 :set #'(lambda (symbol value)
408 (set symbol value)
409 (when (and (boundp 'cua--keymaps-initialized)
410 cua--keymaps-initialized)
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))))
418 :type 'key-sequence
419 :group 'cua)
420
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))
429 :group 'cua)
430
431 (defcustom cua-enable-rectangle-auto-help t
432 "*If non-nil, automatically show help for region, rectangle and global mark."
433 :type 'boolean
434 :group 'cua)
435
436 (defface cua-rectangle
437 '((default :inherit region)
438 (((class color)) :foreground "white" :background "maroon"))
439 "*Font used by CUA for highlighting the rectangle."
440 :group 'cua)
441
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."
446 :group 'cua)
447
448
449 ;;; Global Mark Customization
450
451 (defcustom cua-global-mark-keep-visible t
452 "*If non-nil, always keep global mark visible in other window."
453 :type 'boolean
454 :group 'cua)
455
456 (defface cua-global-mark
457 '((((min-colors 88)(class color)) :foreground "black" :background "yellow1")
458 (((class color)) :foreground "black" :background "yellow")
459 (t :bold t))
460 "*Font used by CUA for highlighting the global mark."
461 :group 'cua)
462
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))
467 :group 'cua)
468
469
470 ;;; Cursor Indication Customization
471
472 (defcustom cua-enable-cursor-indications nil
473 "*If non-nil, use different cursor colors for indications."
474 :type 'boolean
475 :group 'cua)
476
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)
485 "red")
486 "Normal (non-overwrite) cursor color.
487 Default is to load cursor color from initial or default frame parameters.
488
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
494 :type '(choice
495 (color :tag "Color")
496 (choice :tag "Type"
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"
502 (choice :tag "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")))
508 :group 'cua)
509
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.
513
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."
518 :type '(choice
519 (color :tag "Color")
520 (choice :tag "Type"
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"
526 (choice :tag "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")))
532 :group 'cua)
533
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.
537
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."
542 :type '(choice
543 (color :tag "Color")
544 (choice :tag "Type"
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"
550 (choice :tag "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")))
556 :group 'cua)
557
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.
562
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."
567 :type '(choice
568 (color :tag "Color")
569 (choice :tag "Type"
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"
575 (choice :tag "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")))
581 :group 'cua)
582
583
584 ;;; Rectangle support is in cua-rect.el
585
586 (autoload 'cua-set-rectangle-mark "cua-rect"
587 "Start rectangle at mouse click position." t nil)
588
589 ;; Stub definitions until it is loaded
590 (defvar cua--rectangle)
591 (defvar cua--last-killed-rectangle)
592 (unless (featurep 'cua-rect)
593 (setq cua--rectangle nil
594 cua--last-killed-rectangle nil))
595
596 ;; All behind cua--rectangle tests.
597 (declare-function cua-copy-rectangle "cua-rect" (arg))
598 (declare-function cua-cut-rectangle "cua-rect" (arg))
599 (declare-function cua--rectangle-left "cua-rect" (&optional val))
600 (declare-function cua--delete-rectangle "cua-rect" ())
601 (declare-function cua--insert-rectangle "cua-rect"
602 (rect &optional below paste-column line-count))
603 (declare-function cua--rectangle-corner "cua-rect" (&optional advance))
604 (declare-function cua--rectangle-assert "cua-rect" ())
605
606 ;;; Global Mark support is in cua-gmrk.el
607
608 (autoload 'cua-toggle-global-mark "cua-gmrk" nil t nil)
609
610 ;; Stub definitions until cua-gmrk.el is loaded
611 (defvar cua--global-mark-active)
612 (unless (featurep 'cua-gmrk)
613 (setq cua--global-mark-active nil))
614
615 (declare-function cua--insert-at-global-mark "cua-gmrk" (str &optional msg))
616 (declare-function cua--global-mark-post-command "cua-gmrk" ())
617
618
619 ;;; Low-level Interface
620
621 (defvar cua-inhibit-cua-keys nil
622 "Buffer-local variable that may disable the CUA keymappings.")
623 (make-variable-buffer-local 'cua-inhibit-cua-keys)
624
625 ;;; Aux. variables
626
627 ;; Current region was started using cua-set-mark.
628 (defvar cua--explicit-region-start nil)
629 (make-variable-buffer-local 'cua--explicit-region-start)
630
631 ;; Latest region was started using shifted movement command.
632 (defvar cua--last-region-shifted nil)
633
634 ;; buffer + point prior to current command when rectangle is active
635 ;; checked in post-command hook to see if point was moved
636 (defvar cua--buffer-and-point-before-command nil)
637
638 ;; status string for mode line indications
639 (defvar cua--status-string nil)
640 (make-variable-buffer-local 'cua--status-string)
641
642 (defvar cua--debug nil)
643
644
645 ;;; Prefix key override mechanism
646
647 ;; The prefix override (when mark-active) operates in three substates:
648 ;; [1] Before using a prefix key
649 ;; [2] Immediately after using a prefix key
650 ;; [3] A fraction of a second later
651
652 ;; In state [1], the cua--prefix-override-keymap is active.
653 ;; This keymap binds the C-x and C-c prefix keys to the
654 ;; cua--prefix-override-handler function.
655
656 ;; When a prefix key is typed in state [1], cua--prefix-override-handler
657 ;; will push back the keys already read to the event queue. If input is
658 ;; pending, it changes directly to state [3]. Otherwise, a short timer [T]
659 ;; is started, and it changes to state [2].
660
661 ;; In state [2], the cua--prefix-override-keymap is inactive. Instead the
662 ;; cua--prefix-repeat-keymap is active. This keymap binds C-c C-c and C-x
663 ;; C-x to the cua--prefix-repeat-handler function.
664
665 ;; If the prefix key is repeated in state [2], cua--prefix-repeat-handler
666 ;; will cancel [T], back the keys already read (except for the second prefix
667 ;; keys) to the event queue, and changes to state [3].
668
669 ;; The basic cua--cua-keys-keymap binds [C-x timeout] to kill-region and
670 ;; [C-c timeout] to copy-region-as-kill, so if [T] times out in state [2],
671 ;; the cua--prefix-override-timeout function will push a `timeout' event on
672 ;; the event queue, and changes to state [3].
673
674 ;; In state [3] both cua--prefix-override-keymap and cua--prefix-repeat-keymap
675 ;; are inactive, so the timeout in cua-global-keymap binding is used, or the
676 ;; normal prefix key binding from the global or local map will be used.
677
678 ;; The pre-command hook (executed as a consequence of the timeout or normal
679 ;; prefix key binding) will cancel [T] and change from state [3] back to
680 ;; state [1]. So cua--prefix-override-handler and cua--prefix-repeat-handler
681 ;; are always called with state reset to [1]!
682
683 ;; State [1] is recognized by cua--prefix-override-timer is nil,
684 ;; state [2] is recognized by cua--prefix-override-timer is a timer, and
685 ;; state [3] is recognized by cua--prefix-override-timer is t.
686
687 (defvar cua--prefix-override-timer nil)
688 (defvar cua--prefix-override-length nil)
689
690 (defun cua--prefix-override-replay (arg repeat)
691 (let* ((keys (this-command-keys))
692 (i (length keys))
693 (key (aref keys (1- i))))
694 (setq cua--prefix-override-length (- i repeat))
695 (setq cua--prefix-override-timer
696 (or
697 ;; In state [2], change to state [3]
698 (> repeat 0)
699 ;; In state [1], change directly to state [3]
700 (and cua-check-pending-input (input-pending-p))
701 ;; In state [1], [T] disabled, so change to state [3]
702 (not (numberp cua-prefix-override-inhibit-delay))
703 (<= cua-prefix-override-inhibit-delay 0)
704 ;; In state [1], start [T] and change to state [2]
705 (run-with-timer cua-prefix-override-inhibit-delay nil
706 'cua--prefix-override-timeout)))
707 ;; Don't record this command
708 (setq this-command last-command)
709 ;; Restore the prefix arg
710 (setq prefix-arg arg)
711 (reset-this-command-lengths)
712 ;; Push the key back on the event queue
713 (setq unread-command-events (cons key unread-command-events))))
714
715 (defun cua--prefix-override-handler (arg)
716 "Start timer waiting for prefix key to be followed by another key.
717 Repeating prefix key when region is active works as a single prefix key."
718 (interactive "P")
719 (cua--prefix-override-replay arg 0))
720
721 (defun cua--prefix-repeat-handler (arg)
722 "Repeating prefix key when region is active works as a single prefix key."
723 (interactive "P")
724 (cua--prefix-override-replay arg 1))
725
726 (defun cua--prefix-copy-handler (arg)
727 "Copy region/rectangle, then replay last key."
728 (interactive "P")
729 (if cua--rectangle
730 (cua-copy-rectangle arg)
731 (cua-copy-region arg))
732 (let ((keys (this-single-command-keys)))
733 (setq unread-command-events
734 (cons (aref keys (1- (length keys))) unread-command-events))))
735
736 (defun cua--prefix-cut-handler (arg)
737 "Cut region/rectangle, then replay last key."
738 (interactive "P")
739 (if cua--rectangle
740 (cua-cut-rectangle arg)
741 (cua-cut-region arg))
742 (let ((keys (this-single-command-keys)))
743 (setq unread-command-events
744 (cons (aref keys (1- (length keys))) unread-command-events))))
745
746 (defun cua--prefix-override-timeout ()
747 (setq cua--prefix-override-timer t)
748 (when (= (length (this-command-keys)) cua--prefix-override-length)
749 (setq unread-command-events (cons 'timeout unread-command-events))
750 (if prefix-arg
751 (reset-this-command-lengths)
752 (setq overriding-terminal-local-map nil))
753 (cua--select-keymaps)))
754
755
756 ;;; Aux. functions
757
758 (defun cua--fallback ()
759 ;; Execute original command
760 (setq this-command this-original-command)
761 (call-interactively this-command))
762
763 (defun cua--keep-active ()
764 (setq mark-active t
765 deactivate-mark nil))
766
767 (defun cua--deactivate (&optional now)
768 (setq cua--explicit-region-start nil)
769 (if (not now)
770 (setq deactivate-mark t)
771 (setq mark-active nil)
772 (run-hooks 'deactivate-mark-hook)))
773
774
775 ;; The current register prefix
776 (defvar cua--register nil)
777
778 (defun cua--prefix-arg (arg)
779 (setq cua--register
780 (and cua-enable-register-prefix
781 (integerp arg) (>= arg 0) (< arg 10)
782 (let* ((prefix (aref (this-command-keys) 0))
783 (ctrl-u-prefix (and (integerp prefix)
784 (= prefix ?\C-u))))
785 (cond
786 ((eq cua-enable-register-prefix 'not-ctrl-u)
787 (not ctrl-u-prefix))
788 ((eq cua-enable-register-prefix 'ctrl-u-only)
789 ctrl-u-prefix)
790 (t t)))
791 (+ arg ?0)))
792 (if cua--register nil arg))
793
794
795 ;;; Region specific commands
796
797 (defvar cua--last-deleted-region-pos nil)
798 (defvar cua--last-deleted-region-text nil)
799
800 (defun cua-delete-region ()
801 "Delete the active region.
802 Save a copy in register 0 if `cua-delete-copy-to-register-0' is non-nil."
803 (interactive)
804 (let ((start (mark)) (end (point)))
805 (or (<= start end)
806 (setq start (prog1 end (setq end start))))
807 (setq cua--last-deleted-region-text (filter-buffer-substring start end))
808 (if cua-delete-copy-to-register-0
809 (set-register ?0 cua--last-deleted-region-text))
810 (delete-region start end)
811 (setq cua--last-deleted-region-pos
812 (cons (current-buffer)
813 (and (consp buffer-undo-list)
814 (car buffer-undo-list))))
815 (cua--deactivate)
816 (/= start end)))
817
818 (defun cua-replace-region ()
819 "Replace the active region with the character you type."
820 (interactive)
821 (let ((not-empty (and cua-delete-selection (cua-delete-region))))
822 (unless (eq this-original-command this-command)
823 (let ((overwrite-mode
824 (and overwrite-mode
825 not-empty
826 (not (eq this-original-command 'self-insert-command)))))
827 (cua--fallback)))))
828
829 (defun cua-copy-region (arg)
830 "Copy the region to the kill ring.
831 With numeric prefix arg, copy to register 0-9 instead."
832 (interactive "P")
833 (setq arg (cua--prefix-arg arg))
834 (setq cua--last-killed-rectangle nil)
835 (let ((start (mark)) (end (point)))
836 (or (<= start end)
837 (setq start (prog1 end (setq end start))))
838 (cond
839 (cua--register
840 (copy-to-register cua--register start end nil))
841 ((eq this-original-command 'clipboard-kill-ring-save)
842 (clipboard-kill-ring-save start end))
843 (t
844 (copy-region-as-kill start end)))
845 (if cua-keep-region-after-copy
846 (cua--keep-active)
847 (cua--deactivate))))
848
849 (defun cua-cut-region (arg)
850 "Cut the region and copy to the kill ring.
851 With numeric prefix arg, copy to register 0-9 instead."
852 (interactive "P")
853 (setq cua--last-killed-rectangle nil)
854 (if buffer-read-only
855 (cua-copy-region arg)
856 (setq arg (cua--prefix-arg arg))
857 (let ((start (mark)) (end (point)))
858 (or (<= start end)
859 (setq start (prog1 end (setq end start))))
860 (cond
861 (cua--register
862 (copy-to-register cua--register start end t))
863 ((eq this-original-command 'clipboard-kill-region)
864 (clipboard-kill-region start end))
865 (t
866 (kill-region start end))))
867 (cua--deactivate)))
868
869 ;;; Generic commands for regions, rectangles, and global marks
870
871 (defun cua-cancel ()
872 "Cancel the active region, rectangle, or global mark."
873 (interactive)
874 (setq mark-active nil)
875 (setq cua--explicit-region-start nil)
876 (if (fboundp 'cua--cancel-rectangle)
877 (cua--cancel-rectangle)))
878
879 (declare-function x-clipboard-yank "../term/x-win" ())
880
881 (defun cua-paste (arg)
882 "Paste last cut or copied region or rectangle.
883 An active region is deleted before executing the command.
884 With numeric prefix arg, paste from register 0-9 instead.
885 If global mark is active, copy from register or one character."
886 (interactive "P")
887 (setq arg (cua--prefix-arg arg))
888 (let ((regtxt (and cua--register (get-register cua--register)))
889 (count (prefix-numeric-value arg))
890 paste-column paste-lines)
891 (cond
892 ((and cua--register (not regtxt))
893 (message "Nothing in register %c" cua--register))
894 (cua--global-mark-active
895 (if regtxt
896 (cua--insert-at-global-mark regtxt)
897 (when (not (eobp))
898 (cua--insert-at-global-mark (filter-buffer-substring (point) (+ (point) count)))
899 (forward-char count))))
900 (buffer-read-only
901 (message "Cannot paste into a read-only buffer"))
902 (t
903 ;; Must save register here, since delete may override reg 0.
904 (if mark-active
905 (if cua--rectangle
906 (progn
907 (goto-char (min (mark) (point)))
908 (setq paste-column (cua--rectangle-left))
909 (setq paste-lines (cua--delete-rectangle))
910 (if (= paste-lines 1)
911 (setq paste-lines nil))) ;; paste all
912 ;; Before a yank command, make sure we don't yank the
913 ;; head of the kill-ring that really comes from the
914 ;; currently active region we are going to delete.
915 ;; That would make yank a no-op.
916 (if (and (string= (filter-buffer-substring (point) (mark))
917 (car kill-ring))
918 (fboundp 'mouse-region-match)
919 (mouse-region-match))
920 (current-kill 1))
921 (cua-delete-region)))
922 (cond
923 (regtxt
924 (cond
925 ;; This being a cons implies cua-rect is loaded?
926 ((consp regtxt) (cua--insert-rectangle regtxt))
927 ((stringp regtxt) (insert-for-yank regtxt))
928 (t (message "Unknown data in register %c" cua--register))))
929 ((and cua--last-killed-rectangle
930 (eq (and kill-ring (car kill-ring)) (car cua--last-killed-rectangle)))
931 (let ((pt (point)))
932 (when (not (eq buffer-undo-list t))
933 (setq this-command 'cua--paste-rectangle)
934 (undo-boundary)
935 (setq buffer-undo-list (cons pt buffer-undo-list)))
936 (cua--insert-rectangle (cdr cua--last-killed-rectangle)
937 nil paste-column paste-lines)
938 (if arg (goto-char pt))))
939 ((eq this-original-command 'clipboard-yank)
940 (clipboard-yank))
941 ((eq this-original-command 'x-clipboard-yank)
942 (x-clipboard-yank))
943 (t (yank arg)))))))
944
945
946 ;; cua-paste-pop-rotate-temporarily == t mechanism:
947 ;;
948 ;; C-y M-y M-y => only rotates kill ring temporarily,
949 ;; so next C-y yanks what previous C-y yanked,
950 ;;
951 ;; M-y M-y M-y => equivalent to C-y M-y M-y
952 ;;
953 ;; But: After another command, C-u M-y remembers the temporary
954 ;; kill-ring position, so
955 ;; C-u M-y => yanks what the last M-y yanked
956 ;;
957
958 (defvar cua-paste-pop-count nil)
959
960 (defun cua-paste-pop (arg)
961 "Replace a just-pasted text or rectangle with a different text.
962 See `yank-pop' for details about the default behavior. For an alternative
963 behavior, see `cua-paste-pop-rotate-temporarily'."
964 (interactive "P")
965 (cond
966 ((eq last-command 'cua--paste-rectangle)
967 (undo)
968 (yank arg))
969 ((not cua-paste-pop-rotate-temporarily)
970 (yank-pop (prefix-numeric-value arg)))
971 (t
972 (let ((rotate (if (consp arg) 1 (prefix-numeric-value arg))))
973 (cond
974 ((or (null cua-paste-pop-count)
975 (eq last-command 'yank)
976 (eq last-command 'cua-paste))
977 (setq cua-paste-pop-count rotate)
978 (setq last-command 'yank)
979 (yank-pop cua-paste-pop-count))
980 ((and (eq last-command 'cua-paste-pop) (not (consp arg)))
981 (setq cua-paste-pop-count (+ cua-paste-pop-count rotate))
982 (setq last-command 'yank)
983 (yank-pop cua-paste-pop-count))
984 (t
985 (setq cua-paste-pop-count
986 (if (consp arg) (+ cua-paste-pop-count rotate -1) 1))
987 (yank (1+ cua-paste-pop-count)))))
988 ;; Undo rotating the kill-ring, so next C-y will
989 ;; yank the original head.
990 (setq kill-ring-yank-pointer kill-ring)
991 (setq this-command 'cua-paste-pop))))
992
993 (defun cua-exchange-point-and-mark (arg)
994 "Exchanges point and mark, but don't activate the mark.
995 Activates the mark if a prefix argument is given."
996 (interactive "P")
997 (if arg
998 (setq mark-active t)
999 (let (mark-active)
1000 (exchange-point-and-mark)
1001 (if cua--rectangle
1002 (cua--rectangle-corner 0)))))
1003
1004 ;; Typed text that replaced the highlighted region.
1005 (defvar cua--repeat-replace-text nil)
1006
1007 (defun cua-repeat-replace-region (arg)
1008 "Repeat replacing text of highlighted region with typed text.
1009 Searches for the next stretch of text identical to the region last
1010 replaced by typing text over it and replaces it with the same stretch
1011 of text."
1012 (interactive "P")
1013 (when cua--last-deleted-region-pos
1014 (save-excursion
1015 (save-restriction
1016 (set-buffer (car cua--last-deleted-region-pos))
1017 (widen)
1018 ;; Find the text that replaced the region via the undo list.
1019 (let ((ul buffer-undo-list)
1020 (elt (cdr cua--last-deleted-region-pos))
1021 u s e)
1022 (when elt
1023 (while (consp ul)
1024 (setq u (car ul) ul (cdr ul))
1025 (cond
1026 ((eq u elt) ;; got it
1027 (setq ul nil))
1028 ((and (consp u) (integerp (car u)) (integerp (cdr u)))
1029 (if (and s (= (cdr u) s))
1030 (setq s (car u))
1031 (setq s (car u) e (cdr u)))))))
1032 (cond ((and s e (<= s e) (= s (mark t)))
1033 (setq cua--repeat-replace-text
1034 (filter-buffer-substring s e nil t)))
1035 ((and (null s) (eq u elt)) ;; nothing inserted
1036 (setq cua--repeat-replace-text
1037 ""))
1038 (t
1039 (message "Cannot locate replacement text"))))))
1040 (setq cua--last-deleted-region-pos nil))
1041 (if (and cua--last-deleted-region-text
1042 cua--repeat-replace-text
1043 (search-forward cua--last-deleted-region-text nil t nil))
1044 (replace-match cua--repeat-replace-text arg t)))
1045
1046 (defun cua-help-for-region (&optional help)
1047 "Show region specific help in echo area."
1048 (interactive)
1049 (message
1050 (concat (if help "C-?:help " "")
1051 "C-z:undo C-x:cut C-c:copy C-v:paste S-ret:rect")))
1052
1053
1054 ;;; Shift activated / extended region
1055
1056 (defun cua-pop-to-last-change ()
1057 (let ((undo-list buffer-undo-list)
1058 pos elt)
1059 (while (and (not pos)
1060 (consp undo-list))
1061 (setq elt (car undo-list)
1062 undo-list (cdr undo-list))
1063 (cond
1064 ((integerp elt)
1065 (setq pos elt))
1066 ((not (consp elt)))
1067 ((and (integerp (cdr elt))
1068 (or (integerp (car elt)) (stringp (car elt))))
1069 (setq pos (cdr elt)))
1070 ((and (eq (car elt) 'apply) (consp (cdr elt)) (integerp (cadr elt)))
1071 (setq pos (nth 3 elt)))))
1072 (when (and pos
1073 (/= pos (point))
1074 (>= pos (point-min)) (<= pos (point-max)))
1075 (goto-char pos)
1076 t)))
1077
1078 (defun cua-set-mark (&optional arg)
1079 "Set mark at where point is, clear mark, or jump to mark.
1080
1081 With no prefix argument, clear mark if already set. Otherwise, set
1082 mark, and push old mark position on local mark ring; also push mark on
1083 global mark ring if last mark was set in another buffer.
1084
1085 With argument, jump to mark, and pop a new position for mark off
1086 the local mark ring (this does not affect the global mark ring).
1087 Use \\[pop-global-mark] to jump to a mark off the global mark ring
1088 \(see `pop-global-mark').
1089
1090 If `cua-auto-mark-last-change' is non-nil, this command behaves as if there
1091 was an implicit mark at the position of the last buffer change.
1092
1093 Repeating the command without the prefix jumps to the next position
1094 off the local (or global) mark ring.
1095
1096 With a double \\[universal-argument] prefix argument, unconditionally set mark."
1097 (interactive "P")
1098 (cond
1099 ((and (consp arg) (> (prefix-numeric-value arg) 4))
1100 (push-mark-command nil))
1101 ((eq last-command 'pop-to-mark-command)
1102 (setq this-command 'pop-to-mark-command)
1103 (pop-to-mark-command))
1104 ((and (eq last-command 'pop-global-mark) (not arg))
1105 (setq this-command 'pop-global-mark)
1106 (pop-global-mark))
1107 (arg
1108 (setq this-command 'pop-to-mark-command)
1109 (or (and cua-auto-mark-last-change
1110 (cua-pop-to-last-change))
1111 (pop-to-mark-command)))
1112 ((and cua-toggle-set-mark mark-active)
1113 (cua--deactivate)
1114 (message "Mark Cleared"))
1115 (t
1116 (push-mark-command nil nil)
1117 (setq cua--explicit-region-start t)
1118 (setq cua--last-region-shifted nil)
1119 (if cua-enable-region-auto-help
1120 (cua-help-for-region t)))))
1121
1122 ;;; Scrolling commands which does not signal errors at top/bottom
1123 ;;; of buffer at first key-press (instead moves to top/bottom
1124 ;;; of buffer).
1125
1126 (defun cua-scroll-up (&optional arg)
1127 "Scroll text of current window upward ARG lines; or near full screen if no ARG.
1128 If window cannot be scrolled further, move cursor to bottom line instead.
1129 A near full screen is `next-screen-context-lines' less than a full screen.
1130 Negative ARG means scroll downward.
1131 If ARG is the atom `-', scroll downward by nearly full screen."
1132 (interactive "P")
1133 (cond
1134 ((eq arg '-) (cua-scroll-down nil))
1135 ((< (prefix-numeric-value arg) 0)
1136 (cua-scroll-down (- (prefix-numeric-value arg))))
1137 ((eobp)
1138 (scroll-up arg)) ; signal error
1139 (t
1140 (condition-case nil
1141 (scroll-up arg)
1142 (end-of-buffer (goto-char (point-max)))))))
1143
1144 (put 'cua-scroll-up 'CUA 'move)
1145
1146 (defun cua-scroll-down (&optional arg)
1147 "Scroll text of current window downward ARG lines; or near full screen if no ARG.
1148 If window cannot be scrolled further, move cursor to top line instead.
1149 A near full screen is `next-screen-context-lines' less than a full screen.
1150 Negative ARG means scroll upward.
1151 If ARG is the atom `-', scroll upward by nearly full screen."
1152 (interactive "P")
1153 (cond
1154 ((eq arg '-) (cua-scroll-up nil))
1155 ((< (prefix-numeric-value arg) 0)
1156 (cua-scroll-up (- (prefix-numeric-value arg))))
1157 ((bobp)
1158 (scroll-down arg)) ; signal error
1159 (t
1160 (condition-case nil
1161 (scroll-down arg)
1162 (beginning-of-buffer (goto-char (point-min)))))))
1163
1164 (put 'cua-scroll-down 'CUA 'move)
1165
1166 ;;; Cursor indications
1167
1168 (defun cua--update-indications ()
1169 (let* ((cursor
1170 (cond
1171 ((and cua--global-mark-active
1172 cua-global-mark-cursor-color)
1173 cua-global-mark-cursor-color)
1174 ((and buffer-read-only
1175 cua-read-only-cursor-color)
1176 cua-read-only-cursor-color)
1177 ((and cua-overwrite-cursor-color overwrite-mode)
1178 cua-overwrite-cursor-color)
1179 (t cua-normal-cursor-color)))
1180 (color (if (consp cursor) (cdr cursor) cursor))
1181 (type (if (consp cursor) (car cursor) cursor)))
1182 (if (and color
1183 (stringp color)
1184 (not (equal color (frame-parameter nil 'cursor-color))))
1185 (set-cursor-color color))
1186 (if (and type
1187 (symbolp type)
1188 (not (eq type default-cursor-type)))
1189 (setq default-cursor-type type))))
1190
1191
1192 ;;; Pre-command hook
1193
1194 (defun cua--pre-command-handler-1 ()
1195 ;; Cancel prefix key timeout if user enters another key.
1196 (when cua--prefix-override-timer
1197 (if (timerp cua--prefix-override-timer)
1198 (cancel-timer cua--prefix-override-timer))
1199 (setq cua--prefix-override-timer nil))
1200
1201 (cond
1202 ;; Only symbol commands can have necessary properties
1203 ((not (symbolp this-command))
1204 nil)
1205
1206 ;; Handle delete-selection property on non-movement commands
1207 ((not (eq (get this-command 'CUA) 'move))
1208 (when (and mark-active (not deactivate-mark))
1209 (let* ((ds (or (get this-command 'delete-selection)
1210 (get this-command 'pending-delete)))
1211 (nc (cond
1212 ((not ds) nil)
1213 ((eq ds 'yank)
1214 'cua-paste)
1215 ((eq ds 'kill)
1216 (if cua--rectangle
1217 'cua-copy-rectangle
1218 'cua-copy-region))
1219 ((eq ds 'supersede)
1220 (if cua--rectangle
1221 'cua-delete-rectangle
1222 'cua-delete-region))
1223 (t
1224 (if cua--rectangle
1225 'cua-delete-rectangle ;; replace?
1226 'cua-replace-region)))))
1227 (if nc
1228 (setq this-original-command this-command
1229 this-command nc)))))
1230
1231 ;; Handle shifted cursor keys and other movement commands.
1232 ;; If region is not active, region is activated if key is shifted.
1233 ;; If region is active, region is cancelled if key is unshifted
1234 ;; (and region not started with C-SPC).
1235 ;; If rectangle is active, expand rectangle in specified direction and
1236 ;; ignore the movement.
1237 ((if window-system
1238 ;; Shortcut for window-system, assuming that input-decode-map is empty.
1239 (memq 'shift (event-modifiers
1240 (aref (this-single-command-raw-keys) 0)))
1241 (or
1242 ;; Check if the final key-sequence was shifted.
1243 (memq 'shift (event-modifiers
1244 (aref (this-single-command-keys) 0)))
1245 ;; If not, maybe the raw key-sequence was mapped by input-decode-map
1246 ;; to a shifted key (and then mapped down to its unshifted form).
1247 (let* ((keys (this-single-command-raw-keys))
1248 (ev (lookup-key input-decode-map keys)))
1249 (or (and (vector ev) (memq 'shift (event-modifiers (aref ev 0))))
1250 ;; Or maybe, the raw key-sequence was not an escape sequence
1251 ;; and was shifted (and then mapped down to its unshifted form).
1252 (memq 'shift (event-modifiers (aref keys 0)))))))
1253 (unless mark-active
1254 (push-mark-command nil t))
1255 (setq cua--last-region-shifted t)
1256 (setq cua--explicit-region-start nil))
1257
1258 ;; Set mark if user explicitly said to do so
1259 ((or cua--explicit-region-start cua--rectangle)
1260 (unless mark-active
1261 (push-mark-command nil nil)))
1262
1263 ;; Else clear mark after this command.
1264 (t
1265 ;; If we set mark-active to nil here, the region highlight will not be
1266 ;; removed by the direct_output_ commands.
1267 (setq deactivate-mark t)))
1268
1269 ;; Detect extension of rectangles by mouse or other movement
1270 (setq cua--buffer-and-point-before-command
1271 (if cua--rectangle (cons (current-buffer) (point)))))
1272
1273 (defun cua--pre-command-handler ()
1274 (when cua-mode
1275 (condition-case nil
1276 (cua--pre-command-handler-1)
1277 (error nil))))
1278
1279 ;;; Post-command hook
1280
1281 (defun cua--post-command-handler-1 ()
1282 (when cua--global-mark-active
1283 (cua--global-mark-post-command))
1284 (when (fboundp 'cua--rectangle-post-command)
1285 (cua--rectangle-post-command))
1286 (setq cua--buffer-and-point-before-command nil)
1287 (if (or (not mark-active) deactivate-mark)
1288 (setq cua--explicit-region-start nil))
1289
1290 ;; Debugging
1291 (if cua--debug
1292 (cond
1293 (cua--rectangle (cua--rectangle-assert))
1294 (mark-active (message "Mark=%d Point=%d Expl=%s"
1295 (mark t) (point) cua--explicit-region-start))))
1296
1297 ;; Disable transient-mark-mode if rectangle active in current buffer.
1298 (if (not (window-minibuffer-p (selected-window)))
1299 (setq transient-mark-mode (and (not cua--rectangle)
1300 (if cua-highlight-region-shift-only
1301 (not cua--explicit-region-start)
1302 t))))
1303 (if cua-enable-cursor-indications
1304 (cua--update-indications))
1305
1306 (cua--select-keymaps))
1307
1308 (defun cua--post-command-handler ()
1309 (when cua-mode
1310 (condition-case nil
1311 (cua--post-command-handler-1)
1312 (error nil))))
1313
1314
1315 ;;; Keymaps
1316
1317 ;; Cached value of actual cua-rectangle-modifier-key
1318 (defvar cua--rectangle-modifier-key 'meta)
1319
1320 (defun cua--M/H-key (map key fct)
1321 ;; bind H-KEY or M-KEY to FCT in MAP
1322 (unless (listp key) (setq key (list key)))
1323 (define-key map (vector (cons cua--rectangle-modifier-key key)) fct))
1324
1325 (defun cua--self-insert-char-p (def)
1326 ;; Return DEF if current key sequence is self-inserting in
1327 ;; global-map.
1328 (if (memq (global-key-binding (this-single-command-keys))
1329 '(self-insert-command self-insert-iso))
1330 def nil))
1331
1332 (defvar cua-global-keymap (make-sparse-keymap)
1333 "Global keymap for cua-mode; users may add to this keymap.")
1334
1335 (defvar cua--cua-keys-keymap (make-sparse-keymap))
1336 (defvar cua--prefix-override-keymap (make-sparse-keymap))
1337 (defvar cua--prefix-repeat-keymap (make-sparse-keymap))
1338 (defvar cua--global-mark-keymap (make-sparse-keymap)) ; Initialized when cua-gmrk.el is loaded
1339 (defvar cua--rectangle-keymap (make-sparse-keymap)) ; Initialized when cua-rect.el is loaded
1340 (defvar cua--region-keymap (make-sparse-keymap))
1341
1342 (defvar cua--ena-cua-keys-keymap nil)
1343 (defvar cua--ena-prefix-override-keymap nil)
1344 (defvar cua--ena-prefix-repeat-keymap nil)
1345 (defvar cua--ena-region-keymap nil)
1346 (defvar cua--ena-global-mark-keymap nil)
1347
1348 (defvar cua--keymap-alist
1349 `((cua--ena-prefix-override-keymap . ,cua--prefix-override-keymap)
1350 (cua--ena-prefix-repeat-keymap . ,cua--prefix-repeat-keymap)
1351 (cua--ena-cua-keys-keymap . ,cua--cua-keys-keymap)
1352 (cua--ena-global-mark-keymap . ,cua--global-mark-keymap)
1353 (cua--rectangle . ,cua--rectangle-keymap)
1354 (cua--ena-region-keymap . ,cua--region-keymap)
1355 (cua-mode . ,cua-global-keymap)))
1356
1357 (defun cua--select-keymaps ()
1358 ;; Setup conditions for selecting the proper keymaps in cua--keymap-alist.
1359 (setq cua--ena-region-keymap
1360 (and mark-active (not deactivate-mark)))
1361 (setq cua--ena-prefix-override-keymap
1362 (and cua--ena-region-keymap
1363 cua-enable-cua-keys
1364 (not cua-inhibit-cua-keys)
1365 (or (eq cua-enable-cua-keys t)
1366 (not cua--explicit-region-start))
1367 (not executing-kbd-macro)
1368 (not cua--prefix-override-timer)))
1369 (setq cua--ena-prefix-repeat-keymap
1370 (and cua--ena-region-keymap
1371 (or (timerp cua--prefix-override-timer)
1372 (eq cua--prefix-override-timer 'shift))))
1373 (setq cua--ena-cua-keys-keymap
1374 (and cua-enable-cua-keys
1375 (not cua-inhibit-cua-keys)
1376 (or (eq cua-enable-cua-keys t)
1377 cua--last-region-shifted)))
1378 (setq cua--ena-global-mark-keymap
1379 (and cua--global-mark-active
1380 (not (window-minibuffer-p)))))
1381
1382 (defvar cua--keymaps-initialized nil)
1383
1384 (defun cua--shift-control-prefix (prefix arg)
1385 ;; handle S-C-x and S-C-c by emulating the fast double prefix function.
1386 ;; Don't record this command
1387 (setq this-command last-command)
1388 ;; Restore the prefix arg
1389 (setq prefix-arg arg)
1390 (reset-this-command-lengths)
1391 ;; Activate the cua--prefix-repeat-keymap
1392 (setq cua--prefix-override-timer 'shift)
1393 ;; Push duplicate keys back on the event queue
1394 (setq unread-command-events (cons prefix (cons prefix unread-command-events))))
1395
1396 (defun cua--shift-control-c-prefix (arg)
1397 (interactive "P")
1398 (cua--shift-control-prefix ?\C-c arg))
1399
1400 (defun cua--shift-control-x-prefix (arg)
1401 (interactive "P")
1402 (cua--shift-control-prefix ?\C-x arg))
1403
1404 (defun cua--init-keymaps ()
1405 ;; Cache actual rectangle modifier key.
1406 (setq cua--rectangle-modifier-key
1407 (if (and cua-rectangle-modifier-key
1408 (memq window-system '(x)))
1409 cua-rectangle-modifier-key
1410 'meta))
1411 ;; C-return always toggles rectangle mark
1412 (define-key cua-global-keymap cua-rectangle-mark-key 'cua-set-rectangle-mark)
1413 (unless (eq cua--rectangle-modifier-key 'meta)
1414 (cua--M/H-key cua-global-keymap ?\s 'cua-set-rectangle-mark)
1415 (define-key cua-global-keymap
1416 (vector (list cua--rectangle-modifier-key 'mouse-1)) 'cua-mouse-set-rectangle-mark))
1417
1418 (define-key cua-global-keymap [(shift control ?\s)] 'cua-toggle-global-mark)
1419
1420 ;; replace region with rectangle or element on kill ring
1421 (define-key cua-global-keymap [remap yank] 'cua-paste)
1422 (define-key cua-global-keymap [remap clipboard-yank] 'cua-paste)
1423 (define-key cua-global-keymap [remap x-clipboard-yank] 'cua-paste)
1424 ;; replace current yank with previous kill ring element
1425 (define-key cua-global-keymap [remap yank-pop] 'cua-paste-pop)
1426 ;; set mark
1427 (define-key cua-global-keymap [remap set-mark-command] 'cua-set-mark)
1428
1429 ;; scrolling
1430 (define-key cua-global-keymap [remap scroll-up] 'cua-scroll-up)
1431 (define-key cua-global-keymap [remap scroll-down] 'cua-scroll-down)
1432
1433 (define-key cua--cua-keys-keymap [(control x) timeout] 'kill-region)
1434 (define-key cua--cua-keys-keymap [(control c) timeout] 'copy-region-as-kill)
1435 (define-key cua--cua-keys-keymap [(control z)] 'undo)
1436 (define-key cua--cua-keys-keymap [(control v)] 'yank)
1437 (define-key cua--cua-keys-keymap [(meta v)] 'cua-repeat-replace-region)
1438 (define-key cua--cua-keys-keymap [remap exchange-point-and-mark] 'cua-exchange-point-and-mark)
1439
1440 (define-key cua--prefix-override-keymap [(control x)] 'cua--prefix-override-handler)
1441 (define-key cua--prefix-override-keymap [(control c)] 'cua--prefix-override-handler)
1442
1443 (define-key cua--prefix-repeat-keymap [(control x) (control x)] 'cua--prefix-repeat-handler)
1444 (define-key cua--prefix-repeat-keymap [(control x) up] 'cua--prefix-cut-handler)
1445 (define-key cua--prefix-repeat-keymap [(control x) down] 'cua--prefix-cut-handler)
1446 (define-key cua--prefix-repeat-keymap [(control x) left] 'cua--prefix-cut-handler)
1447 (define-key cua--prefix-repeat-keymap [(control x) right] 'cua--prefix-cut-handler)
1448 (define-key cua--prefix-repeat-keymap [(control c) (control c)] 'cua--prefix-repeat-handler)
1449 (define-key cua--prefix-repeat-keymap [(control c) up] 'cua--prefix-copy-handler)
1450 (define-key cua--prefix-repeat-keymap [(control c) down] 'cua--prefix-copy-handler)
1451 (define-key cua--prefix-repeat-keymap [(control c) left] 'cua--prefix-copy-handler)
1452 (define-key cua--prefix-repeat-keymap [(control c) right] 'cua--prefix-copy-handler)
1453
1454 ;; Enable shifted fallbacks for C-x and C-c when region is active
1455 (define-key cua--region-keymap [(shift control x)] 'cua--shift-control-x-prefix)
1456 (define-key cua--region-keymap [(shift control c)] 'cua--shift-control-c-prefix)
1457
1458 ;; replace current region
1459 (define-key cua--region-keymap [remap self-insert-command] 'cua-replace-region)
1460 (define-key cua--region-keymap [remap self-insert-iso] 'cua-replace-region)
1461 (define-key cua--region-keymap [remap insert-register] 'cua-replace-region)
1462 (define-key cua--region-keymap [remap newline-and-indent] 'cua-replace-region)
1463 (define-key cua--region-keymap [remap newline] 'cua-replace-region)
1464 (define-key cua--region-keymap [remap open-line] 'cua-replace-region)
1465 ;; delete current region
1466 (define-key cua--region-keymap [remap delete-backward-char] 'cua-delete-region)
1467 (define-key cua--region-keymap [remap backward-delete-char] 'cua-delete-region)
1468 (define-key cua--region-keymap [remap backward-delete-char-untabify] 'cua-delete-region)
1469 (define-key cua--region-keymap [remap delete-char] 'cua-delete-region)
1470 ;; kill region
1471 (define-key cua--region-keymap [remap kill-region] 'cua-cut-region)
1472 (define-key cua--region-keymap [remap clipboard-kill-region] 'cua-cut-region)
1473 ;; copy region
1474 (define-key cua--region-keymap [remap copy-region-as-kill] 'cua-copy-region)
1475 (define-key cua--region-keymap [remap kill-ring-save] 'cua-copy-region)
1476 (define-key cua--region-keymap [remap clipboard-kill-ring-save] 'cua-copy-region)
1477 ;; cancel current region/rectangle
1478 (define-key cua--region-keymap [remap keyboard-escape-quit] 'cua-cancel)
1479 (define-key cua--region-keymap [remap keyboard-quit] 'cua-cancel)
1480 )
1481
1482
1483 ;; Setup standard movement commands to be recognized by CUA.
1484
1485 (dolist (cmd
1486 '(forward-char backward-char
1487 next-line previous-line
1488 forward-word backward-word
1489 end-of-line beginning-of-line
1490 move-end-of-line move-beginning-of-line
1491 end-of-buffer beginning-of-buffer
1492 scroll-up scroll-down
1493 up-list down-list backward-up-list
1494 end-of-defun beginning-of-defun
1495 forward-sexp backward-sexp
1496 forward-list backward-list
1497 forward-sentence backward-sentence
1498 forward-paragraph backward-paragraph))
1499 (put cmd 'CUA 'move))
1500
1501 ;; State prior to enabling cua-mode
1502 ;; Value is a list with the following elements:
1503 ;; transient-mark-mode
1504 ;; delete-selection-mode
1505 ;; pc-selection-mode
1506
1507 (defvar cua--saved-state nil)
1508
1509 ;;;###autoload
1510 (define-minor-mode cua-mode
1511 "Toggle CUA key-binding mode.
1512 When enabled, using shifted movement keys will activate the
1513 region (and highlight the region using `transient-mark-mode'),
1514 and typed text replaces the active selection.
1515
1516 Also when enabled, you can use C-z, C-x, C-c, and C-v to undo,
1517 cut, copy, and paste in addition to the normal Emacs bindings.
1518 The C-x and C-c keys only do cut and copy when the region is
1519 active, so in most cases, they do not conflict with the normal
1520 function of these prefix keys.
1521
1522 If you really need to perform a command which starts with one of
1523 the prefix keys even when the region is active, you have three
1524 options:
1525 - press the prefix key twice very quickly (within 0.2 seconds),
1526 - press the prefix key and the following key within 0.2 seconds, or
1527 - use the SHIFT key with the prefix key, i.e. C-S-x or C-S-c.
1528
1529 You can customize `cua-enable-cua-keys' to completely disable the
1530 CUA bindings, or `cua-prefix-override-inhibit-delay' to change
1531 the prefix fallback behavior.
1532
1533 CUA mode manages Transient Mark mode internally. Trying to disable
1534 Transient Mark mode while CUA mode is enabled does not work; if you
1535 only want to highlight the region when it is selected using a
1536 shifted movement key, set `cua-highlight-region-shift-only'."
1537 :global t
1538 :group 'cua
1539 :set-after '(cua-enable-modeline-indications
1540 cua-rectangle-mark-key cua-rectangle-modifier-key)
1541 :require 'cua-base
1542 :link '(emacs-commentary-link "cua-base.el")
1543 (setq mark-even-if-inactive t)
1544 (setq highlight-nonselected-windows nil)
1545
1546 (unless cua--keymaps-initialized
1547 (cua--init-keymaps)
1548 (setq cua--keymaps-initialized t))
1549
1550 (if cua-mode
1551 (progn
1552 (add-hook 'pre-command-hook 'cua--pre-command-handler)
1553 (add-hook 'post-command-hook 'cua--post-command-handler)
1554 (if (and cua-enable-modeline-indications (not (assoc 'cua-mode minor-mode-alist)))
1555 (setq minor-mode-alist (cons '(cua-mode cua--status-string) minor-mode-alist)))
1556 (if cua-enable-cursor-indications
1557 (cua--update-indications)))
1558
1559 (remove-hook 'pre-command-hook 'cua--pre-command-handler)
1560 (remove-hook 'post-command-hook 'cua--post-command-handler))
1561
1562 (if (not cua-mode)
1563 (setq emulation-mode-map-alists (delq 'cua--keymap-alist emulation-mode-map-alists))
1564 (add-to-ordered-list 'emulation-mode-map-alists 'cua--keymap-alist 400)
1565 (cua--select-keymaps))
1566
1567 (cond
1568 (cua-mode
1569 (setq cua--saved-state
1570 (list
1571 transient-mark-mode
1572 (and (boundp 'delete-selection-mode) delete-selection-mode)
1573 (and (boundp 'pc-selection-mode) pc-selection-mode)))
1574 (if (and (boundp 'delete-selection-mode) delete-selection-mode)
1575 (delete-selection-mode -1))
1576 (if (and (boundp 'pc-selection-mode) pc-selection-mode)
1577 (pc-selection-mode -1))
1578 (cua--deactivate)
1579 (setq transient-mark-mode (and cua-mode
1580 (if cua-highlight-region-shift-only
1581 (not cua--explicit-region-start)
1582 t))))
1583 (cua--saved-state
1584 (setq transient-mark-mode (car cua--saved-state))
1585 (if (nth 1 cua--saved-state)
1586 (delete-selection-mode 1))
1587 (if (nth 2 cua--saved-state)
1588 (pc-selection-mode 1))
1589 (if (interactive-p)
1590 (message "CUA mode disabled.%s%s%s%s"
1591 (if (nth 1 cua--saved-state) " Delete-Selection" "")
1592 (if (and (nth 1 cua--saved-state) (nth 2 cua--saved-state)) " and" "")
1593 (if (nth 2 cua--saved-state) " PC-Selection" "")
1594 (if (or (nth 1 cua--saved-state) (nth 2 cua--saved-state)) " enabled" "")))
1595 (setq cua--saved-state nil))))
1596
1597
1598 ;;;###autoload
1599 (defun cua-selection-mode (arg)
1600 "Enable CUA selection mode without the C-z/C-x/C-c/C-v bindings."
1601 (interactive "P")
1602 (setq-default cua-enable-cua-keys nil)
1603 (cua-mode arg))
1604
1605
1606 (defun cua-debug ()
1607 "Toggle CUA debugging."
1608 (interactive)
1609 (setq cua--debug (not cua--debug)))
1610
1611
1612 (provide 'cua-base)
1613
1614 ;;; arch-tag: 21fb6289-ba25-4fee-bfdc-f9fb351acf05
1615 ;;; cua-base.el ends here