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