Commit | Line | Data |
---|---|---|
72cc582e KS |
1 | ;;; cua-base.el --- emulate CUA key bindings |
2 | ||
3 | ;; Copyright (C) 1997-2002 Free Software Foundation, Inc. | |
4 | ||
5 | ;; Author: Kim F. Storm <storm@cua.dk> | |
6 | ;; Keywords: keyboard emulation convenience cua | |
7 | ||
8 | ;; This file is part of GNU Emacs. | |
9 | ||
10 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
11 | ;; it under the terms of the GNU General Public License as published by | |
12 | ;; the Free Software Foundation; either version 2, or (at your option) | |
13 | ;; any later version. | |
14 | ||
15 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
16 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 | ;; GNU General Public License for more details. | |
19 | ||
20 | ;; You should have received a copy of the GNU General Public License | |
21 | ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
22 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
23 | ;; Boston, MA 02111-1307, USA. | |
24 | ||
25 | ||
26 | ;;; Commentary: | |
27 | ||
28 | ;; This is the CUA package which provides a complete emulation of the | |
29 | ;; standard CUA key bindings (Motif/Windows/Mac GUI) for selecting and | |
30 | ;; manipulating the region where S-<movement> is used to highlight & | |
31 | ;; extend the region. | |
32 | ||
34a63289 KS |
33 | ;; CUA style key bindings for cut and paste |
34 | ;; ---------------------------------------- | |
35 | ||
36 | ;; This package allows the C-z, C-x, C-c, and C-v keys to be | |
72cc582e KS |
37 | ;; bound appropriately according to the Motif/Windows GUI, i.e. |
38 | ;; C-z -> undo | |
39 | ;; C-x -> cut | |
40 | ;; C-c -> copy | |
41 | ;; C-v -> paste | |
42 | ;; | |
43 | ;; The tricky part is the handling of the C-x and C-c keys which | |
44 | ;; are normally used as prefix keys for most of emacs' built-in | |
45 | ;; commands. With CUA they still do!!! | |
46 | ;; | |
47 | ;; Only when the region is currently active (and highlighted since | |
48 | ;; transient-mark-mode is used), the C-x and C-c keys will work as CUA | |
49 | ;; keys | |
50 | ;; C-x -> cut | |
51 | ;; C-c -> copy | |
52 | ;; When the region is not active, C-x and C-c works as prefix keys! | |
53 | ;; | |
54 | ;; This probably sounds strange and difficult to get used to - but | |
55 | ;; based on my own experience and the feedback from many users of | |
56 | ;; this package, it actually works very well and users adapt to it | |
a1506d29 | 57 | ;; instantly - or at least very quickly. So give it a try! |
72cc582e KS |
58 | ;; ... and in the few cases where you make a mistake and accidentally |
59 | ;; delete the region - you just undo the mistake (with C-z). | |
60 | ;; | |
61 | ;; If you really need to perform a command which starts with one of | |
62 | ;; the prefix keys even when the region is active, you have three options: | |
63 | ;; - press the prefix key twice very quickly (within 0.2 seconds), | |
64 | ;; - press the prefix key and the following key within 0.2 seconds), or | |
65 | ;; - use the SHIFT key with the prefix key, i.e. C-X or C-C | |
66 | ;; | |
67 | ;; This behaviour can be customized via the | |
68 | ;; cua-prefix-override-inhibit-delay variable. | |
69 | ||
70 | ;; In addition to using the shifted movement keys, you can also use | |
71 | ;; [C-space] to start the region and use unshifted movement keys to extend | |
72 | ;; it. To cancel the region, use [C-space] or [C-g]. | |
73 | ||
74 | ;; If you prefer to use the standard emacs cut, copy, paste, and undo | |
75 | ;; bindings, customize cua-enable-cua-keys to nil. | |
76 | ||
34a63289 KS |
77 | |
78 | ;; Typing text replaces the region | |
79 | ;; ------------------------------- | |
80 | ||
81 | ;; When the region is active, i.e. highlighted, the text in region is | |
82 | ;; replaced by the text you type. | |
83 | ||
84 | ;; The replaced text is saved in register 0 which can be inserted using | |
85 | ;; the key sequence M-0 C-v (see the section on register support below). | |
86 | ||
87 | ;; If you have just replaced a highlighted region with typed text, | |
88 | ;; you can repeat the replace with M-v. This will search forward | |
89 | ;; for a streach of text identical to the previous contents of the | |
90 | ;; region (i.e. the contents of register 0) and replace it with the | |
91 | ;; text you typed to replace the original region. Repeating M-v will | |
92 | ;; replace the next matching region and so on. | |
93 | ;; | |
94 | ;; Example: Suppose you have a line like this | |
95 | ;; The redo operation will redo the last redoable command | |
96 | ;; which you want to change into | |
97 | ;; The repeat operation will repeat the last repeatable command | |
98 | ;; This is done by highlighting the first occurrence of "redo" | |
99 | ;; and type "repeat" M-v M-v. | |
100 | ||
101 | ;; Note: Since CUA-mode duplicates the functionality of the | |
102 | ;; delete-selection-mode, that mode is automatically disabled when | |
103 | ;; CUA-mode is enabled. | |
104 | ||
105 | ||
72cc582e KS |
106 | ;; CUA mode indications |
107 | ;; -------------------- | |
108 | ;; You can choose to let CUA use different cursor colors to indicate | |
109 | ;; overwrite mode and read-only buffers. For example, the following | |
110 | ;; setting will use a RED cursor in normal (insertion) mode in | |
111 | ;; read-write buffers, a YELLOW cursor in overwrite mode in read-write | |
112 | ;; buffers, and a GREEN cursor read-only buffers: | |
113 | ;; | |
114 | ;; (setq cua-normal-cursor-color "red") | |
115 | ;; (setq cua-overwrite-cursor-color "yellow") | |
116 | ;; (setq cua-read-only-cursor-color "green") | |
117 | ;; | |
118 | ||
119 | ;; CUA register support | |
120 | ;; -------------------- | |
121 | ;; Emacs' standard register support is also based on a separate set of | |
122 | ;; "register commands". | |
a1506d29 | 123 | ;; |
72cc582e KS |
124 | ;; CUA's register support is activated by providing a numeric |
125 | ;; prefix argument to the C-x, C-c, and C-v commands. For example, | |
126 | ;; to copy the selected region to register 2, enter [M-2 C-c]. | |
127 | ;; Or if you have activated the keypad prefix mode, enter [kp-2 C-c]. | |
a1506d29 | 128 | ;; |
72cc582e KS |
129 | ;; And CUA will copy and paste normal region as well as rectangles |
130 | ;; into the registers, i.e. you use exactly the same command for both. | |
a1506d29 | 131 | ;; |
72cc582e KS |
132 | ;; In addition, the last highlighted text that is deleted (not |
133 | ;; copied), e.g. by [delete] or by typing text over a highlighted | |
134 | ;; region, is automatically saved in register 0, so you can insert it | |
135 | ;; using [M-0 C-v]. | |
136 | ||
137 | ;; CUA rectangle support | |
138 | ;; --------------------- | |
139 | ;; Emacs' normal rectangle support is based on interpreting the region | |
140 | ;; between the mark and point as a "virtual rectangle", and using a | |
141 | ;; completely separate set of "rectangle commands" [C-x r ...] on the | |
142 | ;; region to copy, kill, fill a.s.o. the virtual rectangle. | |
a1506d29 | 143 | ;; |
72cc582e KS |
144 | ;; cua-mode's superior rectangle support is based on using a true visual |
145 | ;; representation of the selected rectangle. To start a rectangle, use | |
146 | ;; [S-return] and extend it using the normal movement keys (up, down, | |
147 | ;; left, right, home, end, C-home, C-end). Once the rectangle has the | |
148 | ;; desired size, you can cut or copy it using C-x and C-c (or C-w and M-w), | |
149 | ;; and you can subsequently insert it - as a rectangle - using C-v (or | |
150 | ;; C-y). So the only new command you need to know to work with | |
151 | ;; cua-mode rectangles is S-return! | |
152 | ;; | |
153 | ;; Normally, when you paste a rectangle using C-v (C-y), each line of | |
154 | ;; the rectangle is inserted into the existing lines in the buffer. | |
155 | ;; If overwrite-mode is active when you paste a rectangle, it is | |
156 | ;; inserted as normal (multi-line) text. | |
a1506d29 | 157 | ;; |
72cc582e KS |
158 | ;; Furthermore, cua-mode's rectangles are not limited to the actual |
159 | ;; contents of the buffer, so if the cursor is currently at the end of a | |
160 | ;; short line, you can still extend the rectangle to include more columns | |
161 | ;; of longer lines in the same rectangle. Sounds strange? Try it! | |
a1506d29 | 162 | ;; |
72cc582e KS |
163 | ;; You can enable padding for just this rectangle by pressing [M-p]; |
164 | ;; this works like entering `picture-mode' where the tabs and spaces | |
165 | ;; are automatically converted/inserted to make the rectangle truly | |
166 | ;; rectangular. Or you can do it for all rectangles by setting the | |
167 | ;; `cua-auto-expand-rectangles' variable. | |
168 | ||
169 | ;; And there's more: If you want to extend or reduce the size of the | |
170 | ;; rectangle in one of the other corners of the rectangle, just use | |
171 | ;; [return] to move the cursor to the "next" corner. Or you can use | |
172 | ;; the [M-up], [M-down], [M-left], and [M-right] keys to move the | |
173 | ;; entire rectangle overlay (but not the contents) in the given | |
174 | ;; direction. | |
175 | ;; | |
176 | ;; [S-return] cancels the rectangle | |
177 | ;; [C-space] activates the region bounded by the rectangle | |
178 | ||
179 | ;; If you type a normal (self-inserting) character when the rectangle is | |
180 | ;; active, the character is inserted on the "current side" of every line | |
181 | ;; of the rectangle. The "current side" is the side on which the cursor | |
182 | ;; is currently located. If the rectangle is only 1 column wide, | |
183 | ;; insertion will be performed to the left when the cursor is at the | |
184 | ;; bottom of the rectangle. So, for example, to comment out an entire | |
185 | ;; paragraph like this one, just place the cursor on the first character | |
186 | ;; of the first line, and enter the following: | |
187 | ;; S-return M-} ; ; <space> S-return | |
a1506d29 | 188 | |
72cc582e KS |
189 | ;; cua-mode's rectangle support also includes all the normal rectangle |
190 | ;; functions with easy access: | |
191 | ;; | |
192 | ;; [M-a] aligns all words at the left edge of the rectangle | |
193 | ;; [M-b] fills the rectangle with blanks (tabs and spaces) | |
194 | ;; [M-c] closes the rectangle by removing all blanks at the left edge | |
195 | ;; of the rectangle | |
196 | ;; [M-f] fills the rectangle with a single character (prompt) | |
197 | ;; [M-i] increases the first number found on each line of the rectangle | |
198 | ;; by the amount given by the numeric prefix argument (default 1) | |
199 | ;; It recognizes 0x... as hexadecimal numbers | |
200 | ;; [M-k] kills the rectangle as normal multi-line text (for paste) | |
201 | ;; [M-l] downcases the rectangle | |
202 | ;; [M-m] copies the rectangle as normal multi-line text (for paste) | |
203 | ;; [M-n] fills each line of the rectangle with increasing numbers using | |
204 | ;; a supplied format string (prompt) | |
a1506d29 | 205 | ;; [M-o] opens the rectangle by moving the highlighted text to the |
72cc582e KS |
206 | ;; right of the rectangle and filling the rectangle with blanks. |
207 | ;; [M-p] toggles rectangle padding, i.e. insert tabs and spaces to | |
208 | ;; make rectangles truly rectangular | |
209 | ;; [M-q] performs text filling on the rectangle | |
210 | ;; [M-r] replaces REGEXP (prompt) by STRING (prompt) in rectangle | |
211 | ;; [M-R] reverse the lines in the rectangle | |
212 | ;; [M-s] fills each line of the rectangle with the same STRING (prompt) | |
213 | ;; [M-t] performs text fill of the rectangle with TEXT (prompt) | |
214 | ;; [M-u] upcases the rectangle | |
215 | ;; [M-|] runs shell command on rectangle | |
216 | ;; [M-'] restricts rectangle to lines with CHAR (prompt) at left column | |
217 | ;; [M-/] restricts rectangle to lines matching REGEXP (prompt) | |
218 | ;; [C-?] Shows a brief list of the above commands. | |
219 | ||
220 | ;; [M-C-up] and [M-C-down] scrolls the lines INSIDE the rectangle up | |
221 | ;; and down; lines scrolled outside the top or bottom of the rectangle | |
222 | ;; are lost, but can be recovered using [C-z]. | |
223 | ||
224 | ;; CUA Global Mark | |
a1506d29 | 225 | ;; --------------- |
72cc582e KS |
226 | ;; The final feature provided by CUA is the "global mark", which |
227 | ;; makes it very easy to copy bits and pieces from the same and other | |
228 | ;; files into the current text. To enable and cancel the global mark, | |
229 | ;; use [S-C-space]. The cursor will blink when the global mark | |
230 | ;; is active. The following commands behave differently when the global | |
231 | ;; mark is set: | |
a1506d29 | 232 | ;; <ch> All characters (including newlines) you type are inserted |
72cc582e KS |
233 | ;; at the global mark! |
234 | ;; [C-x] If you cut a region or rectangle, it is automatically inserted | |
235 | ;; at the global mark, and the global mark is advanced. | |
236 | ;; [C-c] If you copy a region or rectangle, it is immediately inserted | |
237 | ;; at the global mark, and the global mark is advanced. | |
238 | ;; [C-v] Copies a single character to the global mark. | |
239 | ;; [C-d] Moves (i.e. deletes and inserts) a single character to the | |
240 | ;; global mark. | |
241 | ;; [backspace] deletes the character before the global mark, while | |
242 | ;; [delete] deltes the character after the global mark. | |
243 | ||
244 | ;; [S-C-space] Jumps to and cancels the global mark. | |
245 | ;; [C-u S-C-space] Cancels the global mark (stays in current buffer). | |
246 | ||
247 | ;; [TAB] Indents the current line or rectangle to the column of the | |
248 | ;; global mark. | |
249 | ||
250 | ;;; Code: | |
251 | ||
252 | ;;; Customization | |
253 | ||
254 | (defgroup cua nil | |
255 | "Emulate CUA key bindings including C-x and C-c." | |
256 | :prefix "cua" | |
257 | :group 'editing-basics | |
258 | :group 'convenience | |
259 | :group 'emulations | |
260 | :link '(emacs-commentary-link :tag "Commentary" "cua-base.el") | |
261 | :link '(emacs-library-link :tag "Lisp File" "cua-base.el")) | |
262 | ||
263 | ;;;###autoload | |
264 | (defcustom cua-mode nil | |
265 | "Non-nil means that CUA emulation mode is enabled. | |
266 | In CUA mode, shifted movement keys highlight and extend the region. | |
267 | When a region is highlighted, the binding of the C-x and C-c keys are | |
268 | temporarily changed to work as Motif, MAC or MS-Windows cut and paste. | |
269 | Also, insertion commands first delete the region and then insert. | |
270 | This mode enables Transient Mark mode and it provides a superset of the | |
271 | PC Selection Mode and Delete Selection Modes. | |
272 | ||
273 | Setting this variable directly does not take effect; | |
274 | use either \\[customize] or the function `cua-mode'." | |
275 | :set (lambda (symbol value) | |
276 | (cua-mode (or value 0))) | |
277 | :initialize 'custom-initialize-default | |
278 | :set-after '(cua-enable-modeline-indications cua-use-hyper-key) | |
bed8e829 | 279 | :require 'cua-base |
72cc582e KS |
280 | :link '(emacs-commentary-link "cua-base.el") |
281 | :version "21.4" | |
282 | :type 'boolean | |
283 | :group 'cua) | |
284 | ||
285 | ||
286 | (defcustom cua-enable-cua-keys t | |
287 | "*Enable using C-z, C-x, C-c, and C-v for undo, cut, copy, and paste. | |
288 | If the value is t, these mappings are always enabled. If the value is | |
289 | 'shift, these keys are only enabled if the last region was marked with | |
290 | a shifted movement key. If the value is nil, these keys are never | |
291 | enabled." | |
a1506d29 | 292 | :type '(choice (const :tag "Disabled" nil) |
72cc582e | 293 | (const :tag "Shift region only" shift) |
c1cdea1a | 294 | (other :tag "Enabled" t)) |
72cc582e KS |
295 | :group 'cua) |
296 | ||
297 | (defcustom cua-highlight-region-shift-only nil | |
298 | "*If non-nil, only highlight region if marked with S-<move>. | |
299 | When this is non-nil, CUA toggles `transient-mark-mode' on when the region | |
300 | is marked using shifted movement keys, and off when the mark is cleared. | |
301 | But when the mark was set using \\[cua-set-mark], transient-mark-mode | |
302 | is not turned on." | |
303 | :type 'boolean | |
304 | :group 'cua) | |
305 | ||
a1506d29 | 306 | (defcustom cua-prefix-override-inhibit-delay |
72cc582e KS |
307 | (if (featurep 'lisp-float-type) (/ (float 1) (float 5)) nil) |
308 | "*If non-nil, time in seconds to delay before overriding prefix key. | |
309 | If there is additional input within this time, the prefix key is | |
310 | used as a normal prefix key. So typing a key sequence quickly will | |
311 | inhibit overriding the prefix key. | |
312 | As a special case, if the prefix keys repeated within this time, the | |
313 | first prefix key is discarded, so typing a prefix key twice in quick | |
314 | succession will also inhibit overriding the prefix key. | |
315 | If the value is nil, use a shifted prefix key to inhibit the override." | |
316 | :type '(choice (number :tag "Inhibit delay") | |
317 | (const :tag "No delay" nil)) | |
318 | :group 'cua) | |
319 | ||
320 | (defcustom cua-keep-region-after-copy nil | |
321 | "If non-nil, don't deselect the region after copying." | |
322 | :type 'boolean | |
323 | :group 'cua) | |
324 | ||
325 | (defcustom cua-enable-register-prefix 'not-ctrl-u | |
326 | "*If non-nil, registers are supported via numeric prefix arg. | |
327 | If the value is t, any numeric prefix arg in the range 0 to 9 will be | |
a1506d29 | 328 | interpreted as a register number. |
72cc582e | 329 | If the value is not-ctrl-u, using C-u to enter a numeric prefix is not |
a1506d29 | 330 | interpreted as a register number. |
72cc582e KS |
331 | If the value is ctrl-u-only, only numeric prefix entered with C-u is |
332 | interpreted as a register number." | |
a1506d29 | 333 | :type '(choice (const :tag "Disabled" nil) |
72cc582e KS |
334 | (const :tag "Enabled, but C-u arg is not a register" not-ctrl-u) |
335 | (const :tag "Enabled, but only for C-u arg" ctrl-u-only) | |
c1cdea1a | 336 | (other :tag "Enabled" t)) |
72cc582e KS |
337 | :group 'cua) |
338 | ||
339 | (defcustom cua-delete-copy-to-register-0 t | |
340 | "*If non-nil, save last deleted region or rectangle to register 0." | |
341 | :type 'boolean | |
342 | :group 'cua) | |
343 | ||
344 | (defcustom cua-use-hyper-key nil | |
345 | "*If non-nil, bind rectangle commands to H-? instead of M-?. | |
346 | If set to 'also, toggle region command is also on S-return. | |
347 | Must be set prior to enabling CUA." | |
348 | :type '(choice (const :tag "Meta key and S-return" nil) | |
349 | (const :tag "Hyper key only" only) | |
350 | (const :tag "Hyper key and S-return" also)) | |
351 | :group 'cua) | |
352 | ||
353 | (defcustom cua-enable-region-auto-help nil | |
354 | "*If non-nil, automatically show help for active region." | |
355 | :type 'boolean | |
356 | :group 'cua) | |
357 | ||
358 | (defcustom cua-enable-modeline-indications nil | |
359 | "*If non-nil, use minor-mode hook to show status in mode line." | |
360 | :type 'boolean | |
361 | :group 'cua) | |
362 | ||
363 | (defcustom cua-check-pending-input t | |
364 | "*If non-nil, don't override prefix key if input pending. | |
365 | It is rumoured that input-pending-p is unreliable under some window | |
366 | managers, so try setting this to nil, if prefix override doesn't work." | |
367 | :type 'boolean | |
368 | :group 'cua) | |
369 | ||
370 | ||
371 | ;;; Rectangle Customization | |
372 | ||
373 | (defcustom cua-auto-expand-rectangles nil | |
374 | "*If non-nil, rectangles are padded with spaces to make straight edges. | |
375 | This implies modifying buffer contents by expanding tabs and inserting spaces. | |
376 | Consequently, this is inhibited in read-only buffers. | |
377 | Can be toggled by [M-p] while the rectangle is active," | |
378 | :type 'boolean | |
379 | :group 'cua) | |
380 | ||
381 | (defcustom cua-enable-rectangle-auto-help t | |
382 | "*If non-nil, automatically show help for region, rectangle and global mark." | |
383 | :type 'boolean | |
384 | :group 'cua) | |
385 | ||
386 | (defface cua-rectangle-face 'nil | |
387 | "*Font used by CUA for highlighting the rectangle." | |
388 | :group 'cua) | |
389 | ||
390 | (defface cua-rectangle-noselect-face 'nil | |
391 | "*Font used by CUA for highlighting the non-selected rectangle lines." | |
392 | :group 'cua) | |
393 | ||
394 | (defcustom cua-undo-max 64 | |
395 | "*Max no of undoable CUA rectangle changes (including undo)." | |
396 | :type 'integer | |
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 | ||
a1506d29 | 407 | (defface cua-global-mark-face '((((class color)) |
72cc582e KS |
408 | (:foreground "black") |
409 | (: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 | ||
cadc926b | 423 | (defcustom cua-enable-cursor-indications nil |
72cc582e KS |
424 | "*If non-nil, use different cursor colors for indications." |
425 | :type 'boolean | |
426 | :group 'cua) | |
427 | ||
496c17d6 KS |
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") | |
72cc582e KS |
437 | "Normal (non-overwrite) cursor color. |
438 | Also used to indicate that rectangle padding is not in effect. | |
496c17d6 KS |
439 | Default is to load cursor color from initial or default frame parameters." |
440 | :initialize 'custom-initialize-default | |
72cc582e KS |
441 | :type 'color |
442 | :group 'cua) | |
443 | ||
444 | (defcustom cua-read-only-cursor-color "darkgreen" | |
445 | "*Cursor color used in read-only buffers, if non-nil." | |
446 | :type 'color | |
447 | :group 'cua) | |
448 | ||
449 | (defcustom cua-overwrite-cursor-color "yellow" | |
450 | "*Cursor color used when overwrite mode is set, if non-nil. | |
451 | Also used to indicate that rectangle padding is in effect." | |
452 | :type 'color | |
453 | :group 'cua) | |
454 | ||
455 | (defcustom cua-global-mark-cursor-color "cyan" | |
456 | "*Indication for active global mark. | |
457 | Will change cursor color to specified color if string." | |
458 | :type 'color | |
459 | :group 'cua) | |
460 | ||
461 | ||
462 | ;;; Rectangle support is in cua-rect.el | |
463 | ||
464 | (autoload 'cua-set-rectangle-mark "cua-rect" nil t nil) | |
465 | ||
466 | ;; Stub definitions until it is loaded | |
467 | ||
468 | (when (not (featurep 'cua-rect)) | |
469 | (defvar cua--rectangle) | |
470 | (setq cua--rectangle nil) | |
471 | (defvar cua--last-killed-rectangle) | |
472 | (setq cua--last-killed-rectangle nil)) | |
473 | ||
474 | ||
475 | ||
476 | ;;; Global Mark support is in cua-gmrk.el | |
477 | ||
478 | (autoload 'cua-toggle-global-mark "cua-gmrk.el" nil t nil) | |
479 | ||
480 | ;; Stub definitions until cua-gmrk.el is loaded | |
481 | ||
482 | (when (not (featurep 'cua-gmrk)) | |
483 | (defvar cua--global-mark-active) | |
484 | (setq cua--global-mark-active nil)) | |
485 | ||
486 | ||
487 | (provide 'cua-base) | |
488 | ||
489 | (eval-when-compile | |
490 | (require 'cua-rect) | |
491 | (require 'cua-gmrk) | |
492 | ) | |
493 | ||
63e6f5b3 KS |
494 | |
495 | ;;; Low-level Interface | |
496 | ||
497 | (defvar cua-inhibit-cua-keys nil | |
498 | "Buffer-local variable that may disable the cua keymappings.") | |
499 | (make-variable-buffer-local 'cua-inhibit-cua-keys) | |
500 | ||
72cc582e KS |
501 | ;;; Aux. variables |
502 | ||
503 | ;; Current region was started using cua-set-mark. | |
504 | (defvar cua--explicit-region-start nil) | |
505 | ||
506 | ;; Latest region was started using shifted movement command. | |
507 | (defvar cua--last-region-shifted nil) | |
508 | ||
509 | ;; buffer + point prior to current command when rectangle is active | |
510 | ;; checked in post-command hook to see if point was moved | |
511 | (defvar cua--buffer-and-point-before-command nil) | |
512 | ||
513 | ;; status string for mode line indications | |
514 | (defvar cua--status-string nil) | |
515 | ||
516 | (defvar cua--debug nil) | |
517 | ||
518 | ||
519 | ;;; Prefix key override mechanism | |
520 | ||
521 | ;; The prefix override (when mark-active) operates in three substates: | |
522 | ;; [1] Before using a prefix key | |
523 | ;; [2] Immediately after using a prefix key | |
524 | ;; [3] A fraction of a second later | |
525 | ||
526 | ;; In state [1], the cua--prefix-override-keymap is active. | |
527 | ;; This keymap binds the C-x and C-c prefix keys to the | |
528 | ;; cua--prefix-override-handler function. | |
529 | ||
530 | ;; When a prefix key is typed in state [1], cua--prefix-override-handler | |
531 | ;; will push back the keys already read to the event queue. If input is | |
532 | ;; pending, it changes directly to state [3]. Otherwise, a short timer [T] | |
533 | ;; is started, and it changes to state [2]. | |
534 | ||
535 | ;; In state [2], the cua--prefix-override-keymap is inactive. Instead the | |
536 | ;; cua--prefix-repeat-keymap is active. This keymap binds C-c C-c and C-x | |
537 | ;; C-x to the cua--prefix-repeat-handler function. | |
538 | ||
539 | ;; If the prefix key is repeated in state [2], cua--prefix-repeat-handler | |
540 | ;; will cancel [T], back the keys already read (except for the second prefix | |
541 | ;; keys) to the event queue, and changes to state [3]. | |
542 | ||
543 | ;; The basic cua--cua-keys-keymap binds [C-x timeout] to kill-region and | |
544 | ;; [C-c timeout] to copy-region-as-kill, so if [T] times out in state [2], | |
545 | ;; the cua--prefix-override-timeout function will push a `timeout' event on | |
546 | ;; the event queue, and changes to state [3]. | |
547 | ||
548 | ;; In state [3] both cua--prefix-override-keymap and cua--prefix-repeat-keymap | |
549 | ;; are inactive, so the timeout in cua-global-keymap binding is used, or the | |
550 | ;; normal prefix key binding from the global or local map will be used. | |
551 | ||
552 | ;; The pre-command hook (executed as a consequence of the timeout or normal | |
553 | ;; prefix key binding) will cancel [T] and change from state [3] back to | |
554 | ;; state [1]. So cua--prefix-override-handler and cua--prefix-repeat-handler | |
555 | ;; are always called with state reset to [1]! | |
556 | ||
557 | ;; State [1] is recognized by cua--prefix-override-timer is nil, | |
558 | ;; state [2] is recognized by cua--prefix-override-timer is a timer, and | |
559 | ;; state [3] is recognized by cua--prefix-override-timer is t. | |
560 | ||
561 | (defvar cua--prefix-override-timer nil) | |
562 | (defvar cua--prefix-override-length nil) | |
563 | ||
564 | (defun cua--prefix-override-replay (arg repeat) | |
565 | (let* ((keys (this-command-keys)) | |
566 | (i (length keys)) | |
567 | (key (aref keys (1- i)))) | |
568 | (setq cua--prefix-override-length (- i repeat)) | |
569 | (setq cua--prefix-override-timer | |
570 | (or | |
571 | ;; In state [2], change to state [3] | |
572 | (> repeat 0) | |
573 | ;; In state [1], change directly to state [3] | |
574 | (and cua-check-pending-input (input-pending-p)) | |
575 | ;; In state [1], [T] disabled, so change to state [3] | |
576 | (not (numberp cua-prefix-override-inhibit-delay)) | |
577 | (<= cua-prefix-override-inhibit-delay 0) | |
578 | ;; In state [1], start [T] and change to state [2] | |
a1506d29 | 579 | (run-with-timer cua-prefix-override-inhibit-delay nil |
72cc582e KS |
580 | 'cua--prefix-override-timeout))) |
581 | ;; Don't record this command | |
582 | (setq this-command last-command) | |
583 | ;; Restore the prefix arg | |
584 | (setq prefix-arg arg) | |
585 | (reset-this-command-lengths) | |
586 | ;; Push the key back on the event queue | |
587 | (setq unread-command-events (cons key unread-command-events)))) | |
588 | ||
589 | (defun cua--prefix-override-handler (arg) | |
590 | "Start timer waiting for prefix key to be followed by another key. | |
591 | Repeating prefix key when region is active works as a single prefix key." | |
592 | (interactive "P") | |
593 | (cua--prefix-override-replay arg 0)) | |
594 | ||
595 | (defun cua--prefix-repeat-handler (arg) | |
596 | "Repeating prefix key when region is active works as a single prefix key." | |
597 | (interactive "P") | |
598 | (cua--prefix-override-replay arg 1)) | |
599 | ||
600 | (defun cua--prefix-copy-handler (arg) | |
601 | "Copy region/rectangle, then replay last key." | |
602 | (interactive "P") | |
603 | (if cua--rectangle | |
604 | (cua-copy-rectangle arg) | |
605 | (cua-copy-region arg)) | |
606 | (let ((keys (this-single-command-keys))) | |
a1506d29 | 607 | (setq unread-command-events |
72cc582e KS |
608 | (cons (aref keys (1- (length keys))) unread-command-events)))) |
609 | ||
610 | (defun cua--prefix-cut-handler (arg) | |
611 | "Cut region/rectangle, then replay last key." | |
612 | (interactive "P") | |
613 | (if cua--rectangle | |
614 | (cua-cut-rectangle arg) | |
615 | (cua-cut-region arg)) | |
616 | (let ((keys (this-single-command-keys))) | |
a1506d29 | 617 | (setq unread-command-events |
72cc582e KS |
618 | (cons (aref keys (1- (length keys))) unread-command-events)))) |
619 | ||
620 | (defun cua--prefix-override-timeout () | |
621 | (setq cua--prefix-override-timer t) | |
622 | (when (= (length (this-command-keys)) cua--prefix-override-length) | |
623 | (setq unread-command-events (cons 'timeout unread-command-events)) | |
624 | (if prefix-arg | |
625 | (reset-this-command-lengths) | |
626 | (setq overriding-terminal-local-map nil)) | |
a23a8440 | 627 | (cua--select-keymaps))) |
72cc582e KS |
628 | |
629 | ||
630 | ;;; Aux. functions | |
631 | ||
632 | (defun cua--fallback () | |
633 | ;; Execute original command | |
634 | (setq this-command this-original-command) | |
635 | (call-interactively this-command)) | |
a1506d29 | 636 | |
72cc582e KS |
637 | (defun cua--keep-active () |
638 | (setq mark-active t | |
639 | deactivate-mark nil)) | |
640 | ||
641 | (defun cua--deactivate (&optional now) | |
642 | (setq cua--explicit-region-start nil) | |
643 | (if (not now) | |
644 | (setq deactivate-mark t) | |
645 | (setq mark-active nil) | |
646 | (run-hooks 'deactivate-mark-hook))) | |
647 | ||
648 | ||
649 | ;; The current register prefix | |
650 | (defvar cua--register nil) | |
651 | ||
652 | (defun cua--prefix-arg (arg) | |
a1506d29 | 653 | (setq cua--register |
72cc582e | 654 | (and cua-enable-register-prefix |
72cc582e | 655 | (integerp arg) (>= arg 0) (< arg 10) |
1c62c12f KS |
656 | (let* ((prefix (aref (this-command-keys) 0)) |
657 | (ctrl-u-prefix (and (integerp prefix) | |
5632c006 | 658 | (= prefix ?\C-u)))) |
a1506d29 | 659 | (cond |
5632c006 KS |
660 | ((eq cua-enable-register-prefix 'not-ctrl-u) |
661 | (not ctrl-u-prefix)) | |
662 | ((eq cua-enable-register-prefix 'ctrl-u-only) | |
663 | ctrl-u-prefix) | |
664 | (t t))) | |
72cc582e KS |
665 | (+ arg ?0))) |
666 | (if cua--register nil arg)) | |
667 | ||
72cc582e KS |
668 | ;;; Enhanced undo - restore rectangle selections |
669 | ||
670 | (defun cua-undo (&optional arg) | |
671 | "Undo some previous changes. | |
672 | Knows about CUA rectangle highlighting in addition to standard undo." | |
673 | (interactive "*P") | |
674 | (if (fboundp 'cua--rectangle-undo) | |
675 | (cua--rectangle-undo arg) | |
676 | (undo arg))) | |
677 | ||
678 | ;;; Region specific commands | |
679 | ||
5834ac92 KS |
680 | (defvar cua--last-deleted-region-pos nil) |
681 | (defvar cua--last-deleted-region-text nil) | |
682 | ||
72cc582e KS |
683 | (defun cua-delete-region () |
684 | "Delete the active region. | |
685 | Save a copy in register 0 if `cua-delete-copy-to-register-0' is non-nil." | |
686 | (interactive) | |
687 | (let ((start (mark)) (end (point))) | |
688 | (or (<= start end) | |
689 | (setq start (prog1 end (setq end start)))) | |
5834ac92 | 690 | (setq cua--last-deleted-region-text (buffer-substring start end)) |
72cc582e | 691 | (if cua-delete-copy-to-register-0 |
5834ac92 | 692 | (set-register ?0 cua--last-deleted-region-text)) |
72cc582e | 693 | (delete-region start end) |
a1506d29 | 694 | (setq cua--last-deleted-region-pos |
5834ac92 KS |
695 | (cons (current-buffer) |
696 | (and (consp buffer-undo-list) | |
697 | (car buffer-undo-list)))) | |
72cc582e KS |
698 | (cua--deactivate))) |
699 | ||
700 | (defun cua-replace-region () | |
701 | "Replace the active region with the character you type." | |
702 | (interactive) | |
703 | (cua-delete-region) | |
5834ac92 KS |
704 | (unless (eq this-original-command this-command) |
705 | (cua--fallback))) | |
72cc582e KS |
706 | |
707 | (defun cua-copy-region (arg) | |
708 | "Copy the region to the kill ring. | |
709 | With numeric prefix arg, copy to register 0-9 instead." | |
710 | (interactive "P") | |
711 | (setq arg (cua--prefix-arg arg)) | |
712 | (setq cua--last-killed-rectangle nil) | |
713 | (let ((start (mark)) (end (point))) | |
714 | (or (<= start end) | |
715 | (setq start (prog1 end (setq end start)))) | |
716 | (if cua--register | |
717 | (copy-to-register cua--register start end nil) | |
718 | (copy-region-as-kill start end)) | |
719 | (if cua-keep-region-after-copy | |
720 | (cua--keep-active) | |
721 | (cua--deactivate)))) | |
722 | ||
723 | (defun cua-cut-region (arg) | |
724 | "Cut the region and copy to the kill ring. | |
725 | With numeric prefix arg, copy to register 0-9 instead." | |
726 | (interactive "P") | |
727 | (setq cua--last-killed-rectangle nil) | |
728 | (if buffer-read-only | |
729 | (cua-copy-region arg) | |
730 | (setq arg (cua--prefix-arg arg)) | |
731 | (let ((start (mark)) (end (point))) | |
732 | (or (<= start end) | |
733 | (setq start (prog1 end (setq end start)))) | |
734 | (if cua--register | |
735 | (copy-to-register cua--register start end t) | |
736 | (kill-region start end))) | |
737 | (cua--deactivate))) | |
738 | ||
739 | ;;; Generic commands for regions, rectangles, and global marks | |
740 | ||
741 | (defun cua-cancel () | |
742 | "Cancel the active region, rectangle, or global mark." | |
743 | (interactive) | |
744 | (setq mark-active nil) | |
745 | (setq cua--explicit-region-start nil) | |
746 | (if (fboundp 'cua--cancel-rectangle) | |
747 | (cua--cancel-rectangle))) | |
748 | ||
749 | (defun cua-paste (arg) | |
750 | "Paste last cut or copied region or rectangle. | |
751 | An active region is deleted before executing the command. | |
752 | With numeric prefix arg, paste from register 0-9 instead. | |
753 | If global mark is active, copy from register or one character." | |
754 | (interactive "P") | |
755 | (setq arg (cua--prefix-arg arg)) | |
756 | (let ((regtxt (and cua--register (get-register cua--register))) | |
757 | (count (prefix-numeric-value arg))) | |
758 | (cond | |
759 | ((and cua--register (not regtxt)) | |
760 | (message "Nothing in register %c" cua--register)) | |
761 | (cua--global-mark-active | |
762 | (if regtxt | |
763 | (cua--insert-at-global-mark regtxt) | |
764 | (when (not (eobp)) | |
765 | (cua--insert-at-global-mark (buffer-substring (point) (+ (point) count))) | |
766 | (forward-char count)))) | |
767 | (buffer-read-only | |
768 | (message "Cannot paste into a read-only buffer")) | |
769 | (t | |
770 | ;; Must save register here, since delete may override reg 0. | |
771 | (if mark-active | |
772 | ;; Before a yank command, make sure we don't yank | |
773 | ;; the same region that we are going to delete. | |
774 | ;; That would make yank a no-op. | |
775 | (if cua--rectangle | |
776 | (cua--delete-rectangle) | |
777 | (if (string= (buffer-substring (point) (mark)) | |
778 | (car kill-ring)) | |
779 | (current-kill 1)) | |
780 | (cua-delete-region))) | |
781 | (cond | |
782 | (regtxt | |
783 | (cond | |
784 | ((consp regtxt) (cua--insert-rectangle regtxt)) | |
785 | ((stringp regtxt) (insert-for-yank regtxt)) | |
786 | (t (message "Unknown data in register %c" cua--register)))) | |
787 | ((and cua--last-killed-rectangle | |
788 | (eq (and kill-ring (car kill-ring)) (car cua--last-killed-rectangle))) | |
789 | (let ((pt (point))) | |
790 | (when (not (eq buffer-undo-list t)) | |
791 | (setq this-command 'cua--paste-rectangle) | |
792 | (undo-boundary) | |
793 | (setq buffer-undo-list (cons pt buffer-undo-list))) | |
794 | (cua--insert-rectangle (cdr cua--last-killed-rectangle)) | |
795 | (if arg (goto-char pt)))) | |
796 | (t (yank arg))))))) | |
797 | ||
798 | (defun cua-paste-pop (arg) | |
799 | "Replace a just-pasted text or rectangle with a different text. | |
800 | See `yank-pop' for details." | |
801 | (interactive "P") | |
802 | (if (eq last-command 'cua--paste-rectangle) | |
803 | (progn | |
804 | (undo) | |
805 | (yank arg)) | |
806 | (yank-pop (prefix-numeric-value arg)))) | |
807 | ||
808 | (defun cua-exchange-point-and-mark (arg) | |
809 | "Exchanges point and mark, but don't activate the mark. | |
810 | Activates the mark if a prefix argument is given." | |
811 | (interactive "P") | |
812 | (if arg | |
813 | (setq mark-active t) | |
814 | (let (mark-active) | |
815 | (exchange-point-and-mark) | |
816 | (if cua--rectangle | |
817 | (cua--rectangle-corner 0))))) | |
818 | ||
34a63289 KS |
819 | ;; Typed text that replaced the highlighted region. |
820 | (defvar cua--repeat-replace-text nil) | |
821 | ||
822 | (defun cua-repeat-replace-region (arg) | |
823 | "Repeat replacing text of highlighted region with typed text. | |
824 | Searches for the next streach of text identical to the region last | |
825 | replaced by typing text over it and replaces it with the same streach | |
5834ac92 | 826 | of text." |
34a63289 | 827 | (interactive "P") |
5834ac92 KS |
828 | (when cua--last-deleted-region-pos |
829 | (save-excursion | |
830 | (save-restriction | |
831 | (set-buffer (car cua--last-deleted-region-pos)) | |
832 | (widen) | |
833 | ;; Find the text that replaced the region via the undo list. | |
834 | (let ((ul buffer-undo-list) | |
835 | (elt (cdr cua--last-deleted-region-pos)) | |
836 | u s e) | |
837 | (when elt | |
838 | (while (consp ul) | |
839 | (setq u (car ul) ul (cdr ul)) | |
840 | (cond | |
841 | ((eq u elt) ;; got it | |
842 | (setq ul nil)) | |
843 | ((and (consp u) (integerp (car u)) (integerp (cdr u))) | |
844 | (if (and s (= (cdr u) s)) | |
845 | (setq s (car u)) | |
846 | (setq s (car u) e (cdr u))))))) | |
847 | (setq cua--repeat-replace-text | |
848 | (cond ((and s e (<= s e) (= s (mark t))) | |
849 | (buffer-substring-no-properties s e)) | |
850 | ((and (null s) (eq u elt)) ;; nothing inserted | |
851 | "") | |
852 | (t | |
853 | (message "Cannot locate replacement text") | |
854 | nil)))))) | |
855 | (setq cua--last-deleted-region-pos nil)) | |
856 | (if (and cua--last-deleted-region-text | |
857 | cua--repeat-replace-text | |
858 | (search-forward cua--last-deleted-region-text nil t nil)) | |
859 | (replace-match cua--repeat-replace-text arg t))) | |
34a63289 | 860 | |
72cc582e KS |
861 | (defun cua-help-for-region (&optional help) |
862 | "Show region specific help in echo area." | |
863 | (interactive) | |
a1506d29 | 864 | (message |
72cc582e KS |
865 | (concat (if help "C-?:help " "") |
866 | "C-z:undo C-x:cut C-c:copy C-v:paste S-ret:rect"))) | |
867 | ||
868 | ||
869 | ;;; Shift activated / extended region | |
870 | ||
871 | (defun cua-set-mark (&optional arg) | |
872 | "Set mark at where point is, clear mark, or jump to mark. | |
f45a6831 KS |
873 | |
874 | With no prefix argument, clear mark if already set. Otherwise, set | |
875 | mark, and push old mark position on local mark ring; also push mark on | |
876 | global mark ring if last mark was set in another buffer. | |
877 | ||
878 | With argument, jump to mark, and pop a new position for mark off | |
879 | the local mark ring \(this does not affect the global mark ring\). | |
880 | Use \\[pop-global-mark] to jump to a mark off the global mark ring | |
881 | \(see `pop-global-mark'\). Repeating the command without the prefix | |
882 | jumps to the next position off the local \(or global\) mark ring. | |
883 | ||
884 | With a double \\[universal-argument] prefix argument, unconditionally set mark." | |
72cc582e | 885 | (interactive "P") |
72cc582e | 886 | (cond |
f45a6831 KS |
887 | ((and (consp arg) (> (prefix-numeric-value arg) 4)) |
888 | (push-mark-command nil)) | |
fc803e8d | 889 | ((eq last-command 'pop-to-mark-command) |
f45a6831 KS |
890 | (setq this-command 'pop-to-mark-command) |
891 | (pop-to-mark-command)) | |
48ce734b KS |
892 | ((and pop-global-mark-quick-repeat |
893 | (eq last-command 'pop-global-mark) (not arg)) | |
f45a6831 KS |
894 | (setq this-command 'pop-global-mark) |
895 | (pop-global-mark)) | |
72cc582e | 896 | (arg |
fc803e8d KS |
897 | (setq this-command 'pop-to-mark-command) |
898 | (pop-to-mark-command)) | |
72cc582e KS |
899 | (mark-active |
900 | (cua--deactivate) | |
901 | (message "Mark Cleared")) | |
902 | (t | |
fc803e8d | 903 | (push-mark-command nil nil) |
72cc582e KS |
904 | (setq cua--explicit-region-start t) |
905 | (setq cua--last-region-shifted nil) | |
906 | (if cua-enable-region-auto-help | |
907 | (cua-help-for-region t))))) | |
908 | ||
909 | (defvar cua--standard-movement-commands | |
910 | '(forward-char backward-char | |
911 | next-line previous-line | |
912 | forward-word backward-word | |
913 | end-of-line beginning-of-line | |
914 | end-of-buffer beginning-of-buffer | |
915 | scroll-up scroll-down forward-paragraph backward-paragraph) | |
916 | "List of standard movement commands. | |
9715510b | 917 | Extra commands should be added to `cua-movement-commands'") |
72cc582e KS |
918 | |
919 | (defvar cua-movement-commands nil | |
920 | "User may add additional movement commands to this list.") | |
921 | ||
922 | ||
923 | ;;; Cursor indications | |
924 | ||
925 | (defun cua--update-indications () | |
926 | (let ((cursor | |
927 | (cond | |
928 | ((and cua--global-mark-active | |
929 | (stringp cua-global-mark-cursor-color)) | |
930 | cua-global-mark-cursor-color) | |
931 | ((and buffer-read-only | |
932 | (stringp cua-read-only-cursor-color)) | |
933 | cua-read-only-cursor-color) | |
934 | ((and (stringp cua-overwrite-cursor-color) | |
935 | (or overwrite-mode | |
936 | (and cua--rectangle (cua--rectangle-padding)))) | |
937 | cua-overwrite-cursor-color) | |
938 | (t cua-normal-cursor-color)))) | |
939 | (if (and cursor | |
940 | (not (equal cursor (frame-parameter nil 'cursor-color)))) | |
941 | (set-cursor-color cursor)) | |
942 | cursor)) | |
943 | ||
944 | ||
945 | ;;; Pre-command hook | |
946 | ||
947 | (defun cua--pre-command-handler () | |
948 | (condition-case nil | |
949 | (let ((movement (or (memq this-command cua--standard-movement-commands) | |
950 | (memq this-command cua-movement-commands)))) | |
951 | ||
952 | ;; Cancel prefix key timeout if user enters another key. | |
953 | (when cua--prefix-override-timer | |
954 | (if (timerp cua--prefix-override-timer) | |
955 | (cancel-timer cua--prefix-override-timer)) | |
956 | (setq cua--prefix-override-timer nil)) | |
957 | ||
958 | ;; Handle shifted cursor keys and other movement commands. | |
959 | ;; If region is not active, region is activated if key is shifted. | |
960 | ;; If region is active, region is cancelled if key is unshifted (and region not started with C-SPC). | |
961 | ;; If rectangle is active, expand rectangle in specified direction and ignore the movement. | |
962 | (if movement | |
963 | (cond | |
964 | ((memq 'shift (event-modifiers (aref (this-single-command-raw-keys) 0))) | |
965 | (unless mark-active | |
fc803e8d | 966 | (push-mark-command nil t)) |
72cc582e KS |
967 | (setq cua--last-region-shifted t) |
968 | (setq cua--explicit-region-start nil)) | |
969 | ((or cua--explicit-region-start cua--rectangle) | |
970 | (unless mark-active | |
fc803e8d | 971 | (push-mark-command nil nil))) |
72cc582e | 972 | (t |
a1506d29 | 973 | ;; If we set mark-active to nil here, the region highlight will not be |
72cc582e KS |
974 | ;; removed by the direct_output_ commands. |
975 | (setq deactivate-mark t))) | |
976 | ||
977 | ;; Handle delete-selection property on other commands | |
e75d337c KS |
978 | (if (and mark-active (not deactivate-mark)) |
979 | (let* ((ds (or (get this-command 'delete-selection) | |
980 | (get this-command 'pending-delete))) | |
981 | (nc (cond | |
982 | ((not ds) nil) | |
a1506d29 | 983 | ((eq ds 'yank) |
e75d337c KS |
984 | 'cua-paste) |
985 | ((eq ds 'kill) | |
986 | (if cua--rectangle | |
987 | 'cua-copy-rectangle | |
988 | 'cua-copy-region)) | |
989 | ((eq ds 'supersede) | |
990 | (if cua--rectangle | |
ad9de65b KS |
991 | 'cua-delete-rectangle |
992 | 'cua-delete-region)) | |
e75d337c KS |
993 | (t |
994 | (if cua--rectangle | |
ad9de65b KS |
995 | 'cua-delete-rectangle ;; replace? |
996 | 'cua-replace-region))))) | |
e75d337c KS |
997 | (if nc |
998 | (setq this-original-command this-command | |
999 | this-command nc))))) | |
a1506d29 | 1000 | |
72cc582e | 1001 | ;; Detect extension of rectangles by mouse or other movement |
a1506d29 | 1002 | (setq cua--buffer-and-point-before-command |
72cc582e KS |
1003 | (if cua--rectangle (cons (current-buffer) (point)))) |
1004 | ) | |
1005 | (error nil))) | |
1006 | ||
1007 | ;;; Post-command hook | |
1008 | ||
1009 | (defun cua--post-command-handler () | |
1010 | (condition-case nil | |
1011 | (progn | |
1012 | (when cua--global-mark-active | |
1013 | (cua--global-mark-post-command)) | |
1014 | (when (fboundp 'cua--rectangle-post-command) | |
1015 | (cua--rectangle-post-command)) | |
1016 | (setq cua--buffer-and-point-before-command nil) | |
1017 | (if (or (not mark-active) deactivate-mark) | |
1018 | (setq cua--explicit-region-start nil)) | |
1019 | ||
1020 | ;; Debugging | |
1021 | (if cua--debug | |
a1506d29 | 1022 | (cond |
72cc582e KS |
1023 | (cua--rectangle (cua--rectangle-assert)) |
1024 | (mark-active (message "Mark=%d Point=%d Expl=%s" | |
1025 | (mark t) (point) cua--explicit-region-start)))) | |
1026 | ||
1027 | ;; Disable transient-mark-mode if rectangle active in current buffer. | |
1028 | (if (not (window-minibuffer-p (selected-window))) | |
1029 | (setq transient-mark-mode (and (not cua--rectangle) | |
1030 | (if cua-highlight-region-shift-only | |
1031 | (not cua--explicit-region-start) | |
1032 | t)))) | |
1033 | (if cua-enable-cursor-indications | |
1034 | (cua--update-indications)) | |
1035 | ||
a23a8440 | 1036 | (cua--select-keymaps) |
72cc582e KS |
1037 | ) |
1038 | ||
1039 | (error nil))) | |
1040 | ||
1041 | ||
1042 | ;;; Keymaps | |
1043 | ||
1044 | (defun cua--M/H-key (map key fct) | |
1045 | ;; bind H-KEY or M-KEY to FCT in MAP | |
1046 | (if (eq key 'space) (setq key ? )) | |
1047 | (unless (listp key) (setq key (list key))) | |
1048 | (define-key map (vector (cons (if cua-use-hyper-key 'hyper 'meta) key)) fct)) | |
1049 | ||
20023b9c KS |
1050 | (defun cua--self-insert-char-p (def) |
1051 | ;; Return DEF if current key sequence is self-inserting in | |
1052 | ;; global-map. | |
1053 | (if (memq (global-key-binding (this-single-command-keys)) | |
1054 | '(self-insert-command self-insert-iso)) | |
1055 | def nil)) | |
1056 | ||
a23a8440 KS |
1057 | (defvar cua-global-keymap (make-sparse-keymap) |
1058 | "Global keymap for cua-mode; users may add to this keymap.") | |
1059 | ||
72cc582e KS |
1060 | (defvar cua--cua-keys-keymap (make-sparse-keymap)) |
1061 | (defvar cua--prefix-override-keymap (make-sparse-keymap)) | |
1062 | (defvar cua--prefix-repeat-keymap (make-sparse-keymap)) | |
1063 | (defvar cua--global-mark-keymap (make-sparse-keymap)) ; Initalized when cua-gmrk.el is loaded | |
1064 | (defvar cua--rectangle-keymap (make-sparse-keymap)) ; Initalized when cua-rect.el is loaded | |
1065 | (defvar cua--region-keymap (make-sparse-keymap)) | |
1066 | ||
1067 | (defvar cua--ena-cua-keys-keymap nil) | |
1068 | (defvar cua--ena-prefix-override-keymap nil) | |
1069 | (defvar cua--ena-prefix-repeat-keymap nil) | |
1070 | (defvar cua--ena-region-keymap nil) | |
1071 | (defvar cua--ena-global-mark-keymap nil) | |
1072 | ||
a23a8440 KS |
1073 | (defvar cua--keymap-alist |
1074 | `((cua--ena-prefix-override-keymap . ,cua--prefix-override-keymap) | |
1075 | (cua--ena-prefix-repeat-keymap . ,cua--prefix-repeat-keymap) | |
1076 | (cua--ena-cua-keys-keymap . ,cua--cua-keys-keymap) | |
1077 | (cua--ena-global-mark-keymap . ,cua--global-mark-keymap) | |
1078 | (cua--rectangle . ,cua--rectangle-keymap) | |
1079 | (cua--ena-region-keymap . ,cua--region-keymap) | |
1080 | (cua-mode . ,cua-global-keymap))) | |
1081 | ||
1082 | (defun cua--select-keymaps () | |
1083 | ;; Setup conditions for selecting the proper keymaps in cua--keymap-alist. | |
72cc582e KS |
1084 | (setq cua--ena-region-keymap |
1085 | (and mark-active (not deactivate-mark))) | |
1086 | (setq cua--ena-prefix-override-keymap | |
1087 | (and cua--ena-region-keymap | |
1088 | cua-enable-cua-keys | |
63e6f5b3 | 1089 | (not cua-inhibit-cua-keys) |
72cc582e KS |
1090 | (or (eq cua-enable-cua-keys t) |
1091 | (not cua--explicit-region-start)) | |
1092 | (not executing-kbd-macro) | |
1093 | (not cua--prefix-override-timer))) | |
1094 | (setq cua--ena-prefix-repeat-keymap | |
1095 | (and cua--ena-region-keymap | |
1096 | (timerp cua--prefix-override-timer))) | |
1097 | (setq cua--ena-cua-keys-keymap | |
1098 | (and cua-enable-cua-keys | |
63e6f5b3 | 1099 | (not cua-inhibit-cua-keys) |
72cc582e KS |
1100 | (or (eq cua-enable-cua-keys t) |
1101 | cua--last-region-shifted))) | |
1102 | (setq cua--ena-global-mark-keymap | |
1103 | (and cua--global-mark-active | |
1104 | (not (window-minibuffer-p))))) | |
1105 | ||
1106 | (defvar cua--keymaps-initalized nil) | |
1107 | ||
1108 | (defun cua--init-keymaps () | |
1109 | (unless (eq cua-use-hyper-key 'only) | |
1110 | (define-key cua-global-keymap [(shift return)] 'cua-set-rectangle-mark)) | |
1111 | (when cua-use-hyper-key | |
1112 | (cua--M/H-key cua-global-keymap 'space 'cua-set-rectangle-mark) | |
1113 | (define-key cua-global-keymap [(hyper mouse-1)] 'cua-mouse-set-rectangle-mark)) | |
1114 | ||
1115 | (define-key cua-global-keymap [(shift control ? )] 'cua-toggle-global-mark) | |
1116 | ||
1117 | ;; replace region with rectangle or element on kill ring | |
1118 | (define-key cua-global-keymap [remap yank] 'cua-paste) | |
1119 | (define-key cua-global-keymap [remap clipboard-yank] 'cua-paste) | |
1120 | ;; replace current yank with previous kill ring element | |
1121 | (define-key cua-global-keymap [remap yank-pop] 'cua-paste-pop) | |
1122 | ;; set mark | |
1123 | (define-key cua-global-keymap [remap set-mark-command] 'cua-set-mark) | |
1124 | ;; undo | |
1125 | (define-key cua-global-keymap [remap undo] 'cua-undo) | |
1126 | (define-key cua-global-keymap [remap advertised-undo] 'cua-undo) | |
1127 | ||
1128 | (define-key cua--cua-keys-keymap [(control x) timeout] 'kill-region) | |
72cc582e | 1129 | (define-key cua--cua-keys-keymap [(control c) timeout] 'copy-region-as-kill) |
72cc582e KS |
1130 | (define-key cua--cua-keys-keymap [(control z)] 'undo) |
1131 | (define-key cua--cua-keys-keymap [(control v)] 'yank) | |
34a63289 | 1132 | (define-key cua--cua-keys-keymap [(meta v)] 'cua-repeat-replace-region) |
72cc582e KS |
1133 | (define-key cua--cua-keys-keymap [remap exchange-point-and-mark] 'cua-exchange-point-and-mark) |
1134 | ||
1135 | (define-key cua--prefix-override-keymap [(control x)] 'cua--prefix-override-handler) | |
1136 | (define-key cua--prefix-override-keymap [(control c)] 'cua--prefix-override-handler) | |
a1506d29 | 1137 | |
72cc582e KS |
1138 | (define-key cua--prefix-repeat-keymap [(control x) (control x)] 'cua--prefix-repeat-handler) |
1139 | (define-key cua--prefix-repeat-keymap [(control x) up] 'cua--prefix-cut-handler) | |
1140 | (define-key cua--prefix-repeat-keymap [(control x) down] 'cua--prefix-cut-handler) | |
1141 | (define-key cua--prefix-repeat-keymap [(control x) left] 'cua--prefix-cut-handler) | |
1142 | (define-key cua--prefix-repeat-keymap [(control x) right] 'cua--prefix-cut-handler) | |
1143 | (define-key cua--prefix-repeat-keymap [(control c) (control c)] 'cua--prefix-repeat-handler) | |
1144 | (define-key cua--prefix-repeat-keymap [(control c) up] 'cua--prefix-copy-handler) | |
1145 | (define-key cua--prefix-repeat-keymap [(control c) down] 'cua--prefix-copy-handler) | |
1146 | (define-key cua--prefix-repeat-keymap [(control c) left] 'cua--prefix-copy-handler) | |
1147 | (define-key cua--prefix-repeat-keymap [(control c) right] 'cua--prefix-copy-handler) | |
1148 | ||
a1506d29 | 1149 | ;; Enable shifted fallbacks for C-x and C-c when region is active |
d6f9ff15 KS |
1150 | (define-key cua--region-keymap [(shift control x)] 'Control-X-prefix) |
1151 | (define-key cua--region-keymap [(shift control c)] 'mode-specific-command-prefix) | |
72cc582e KS |
1152 | ;; replace current region |
1153 | (define-key cua--region-keymap [remap self-insert-command] 'cua-replace-region) | |
1154 | (define-key cua--region-keymap [remap self-insert-iso] 'cua-replace-region) | |
1155 | (define-key cua--region-keymap [remap insert-register] 'cua-replace-region) | |
1156 | (define-key cua--region-keymap [remap newline-and-indent] 'cua-replace-region) | |
1157 | (define-key cua--region-keymap [remap newline] 'cua-replace-region) | |
1158 | (define-key cua--region-keymap [remap open-line] 'cua-replace-region) | |
1159 | ;; delete current region | |
1160 | (define-key cua--region-keymap [remap delete-backward-char] 'cua-delete-region) | |
1161 | (define-key cua--region-keymap [remap backward-delete-char] 'cua-delete-region) | |
1162 | (define-key cua--region-keymap [remap backward-delete-char-untabify] 'cua-delete-region) | |
1163 | (define-key cua--region-keymap [remap delete-char] 'cua-delete-region) | |
1164 | ;; kill region | |
1165 | (define-key cua--region-keymap [remap kill-region] 'cua-cut-region) | |
1166 | ;; copy region | |
1167 | (define-key cua--region-keymap [remap copy-region-as-kill] 'cua-copy-region) | |
1168 | (define-key cua--region-keymap [remap kill-ring-save] 'cua-copy-region) | |
1169 | ;; cancel current region/rectangle | |
1170 | (define-key cua--region-keymap [remap keyboard-escape-quit] 'cua-cancel) | |
1171 | (define-key cua--region-keymap [remap keyboard-quit] 'cua-cancel) | |
1172 | ) | |
1173 | ||
cadc926b KS |
1174 | ;; State prior to enabling cua-mode |
1175 | ;; Value is a list with the following elements: | |
1176 | ;; transient-mark-mode | |
1177 | ;; delete-selection-mode | |
1178 | ;; pc-selection-mode | |
1179 | ||
1180 | (defvar cua--saved-state nil) | |
72cc582e KS |
1181 | |
1182 | ;;;###autoload | |
1183 | (defun cua-mode (&optional arg) | |
1184 | "Toggle CUA key-binding mode. | |
1185 | When enabled, using shifted movement keys will activate the region (and | |
1186 | highlight the region using `transient-mark-mode'), and typed text replaces | |
1187 | the active selection. C-z, C-x, C-c, and C-v will undo, cut, copy, and | |
1188 | paste (in addition to the normal emacs bindings)." | |
1189 | (interactive "P") | |
1190 | (setq cua-mode | |
1191 | (cond | |
1192 | ((null arg) (not cua-mode)) | |
1193 | ((symbolp arg) t) | |
1194 | (t (> (prefix-numeric-value arg) 0)))) | |
1195 | ||
1196 | (setq mark-even-if-inactive t) | |
1197 | (setq highlight-nonselected-windows nil) | |
1198 | (make-variable-buffer-local 'cua--explicit-region-start) | |
1199 | (make-variable-buffer-local 'cua--status-string) | |
1200 | ||
1201 | (unless cua--keymaps-initalized | |
1202 | (cua--init-keymaps) | |
1203 | (setq cua--keymaps-initalized t)) | |
1204 | ||
1205 | (if cua-mode | |
1206 | (progn | |
1207 | (add-hook 'pre-command-hook 'cua--pre-command-handler) | |
1208 | (add-hook 'post-command-hook 'cua--post-command-handler) | |
1209 | (if (and cua-enable-modeline-indications (not (assoc 'cua-mode minor-mode-alist))) | |
1210 | (setq minor-mode-alist (cons '(cua-mode cua--status-string) minor-mode-alist))) | |
1211 | ) | |
1212 | (remove-hook 'pre-command-hook 'cua--pre-command-handler) | |
1213 | (remove-hook 'post-command-hook 'cua--post-command-handler)) | |
a23a8440 KS |
1214 | |
1215 | (if (not cua-mode) | |
1216 | (setq emulation-mode-map-alists (delq 'cua--keymap-alist emulation-mode-map-alists)) | |
1217 | (add-to-list 'emulation-mode-map-alists 'cua--keymap-alist) | |
1218 | (cua--select-keymaps)) | |
1219 | ||
72cc582e KS |
1220 | (if (fboundp 'cua--rectangle-on-off) |
1221 | (cua--rectangle-on-off cua-mode)) | |
cadc926b KS |
1222 | |
1223 | (cond | |
1224 | (cua-mode | |
1225 | (setq cua--saved-state | |
1226 | (list | |
1227 | transient-mark-mode | |
1228 | (and (boundp 'delete-selection-mode) delete-selection-mode) | |
1229 | (and (boundp 'pc-selection-mode) pc-selection-mode))) | |
1230 | (if (and (boundp 'delete-selection-mode) delete-selection-mode) | |
1231 | (delete-selection-mode)) | |
1232 | (if (and (boundp 'pc-selection-mode) pc-selection-mode) | |
1233 | (pc-selection-mode)) | |
1234 | (setq transient-mark-mode (and cua-mode | |
1235 | (if cua-highlight-region-shift-only | |
1236 | (not cua--explicit-region-start) | |
1237 | t))) | |
1238 | (if (interactive-p) | |
1239 | (message "CUA mode enabled"))) | |
1240 | (cua--saved-state | |
1241 | (setq transient-mark-mode (car cua--saved-state)) | |
1242 | (if (nth 1 cua--saved-state) | |
1243 | (delete-selection-mode 1)) | |
1244 | (if (nth 2 cua--saved-state) | |
1245 | (pc-selection-mode 1)) | |
1246 | (if (interactive-p) | |
1247 | (message "CUA mode disabled.%s%s%s%s" | |
1248 | (if (nth 1 cua--saved-state) " Delete-Selection" "") | |
1249 | (if (and (nth 1 cua--saved-state) (nth 2 cua--saved-state)) " and" "") | |
1250 | (if (nth 2 cua--saved-state) " PC-Selection" "") | |
1251 | (if (or (nth 1 cua--saved-state) (nth 2 cua--saved-state)) " enabled" ""))) | |
1252 | (setq cua--saved-state nil)) | |
1253 | ||
1254 | (t | |
1255 | (if (interactive-p) | |
1256 | (message "CUA mode disabled"))))) | |
72cc582e KS |
1257 | |
1258 | (defun cua-debug () | |
1259 | "Toggle cua debugging." | |
1260 | (interactive) | |
1261 | (setq cua--debug (not cua--debug))) | |
1262 | ||
06f8e605 KS |
1263 | ;; Install run-time check for older versions of CUA-mode which does not |
1264 | ;; work with GNU Emacs version 21.4 and newer. | |
1265 | ;; | |
1266 | ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode | |
1267 | ;; provided the `CUA-mode' feature. Since this is no longer true, | |
1268 | ;; we can warn the user if the `CUA-mode' feature is ever provided. | |
1269 | ||
1270 | ;;;###autoload (eval-after-load 'CUA-mode | |
1271 | ;;;###autoload '(error (concat "\n\n" | |
1272 | ;;;###autoload "CUA-mode is now part of the standard GNU Emacs distribution,\n" | |
1273 | ;;;###autoload "so you may now enable and customize CUA via the Options menu.\n\n" | |
1274 | ;;;###autoload "Your " (file-name-nondirectory user-init-file) " loads an older version of CUA-mode which does\n" | |
1275 | ;;;###autoload "not work correctly with this version of GNU Emacs.\n" | |
1276 | ;;;###autoload "To correct this, remove the loading and customization of the\n" | |
1277 | ;;;###autoload "old version from the " user-init-file " file.\n\n"))) | |
1278 | ||
f1cb14f8 KS |
1279 | (provide 'cua) |
1280 | ||
72cc582e | 1281 | ;;; cua-base.el ends here |