Commit | Line | Data |
---|---|---|
72cc582e KS |
1 | ;;; cua-base.el --- emulate CUA key bindings |
2 | ||
d7672cf8 | 3 | ;; Copyright (C) 1997,98,99,200,01,02,03 Free Software Foundation, Inc. |
72cc582e KS |
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 | ||
72cc582e KS |
263 | (defcustom cua-enable-cua-keys t |
264 | "*Enable using C-z, C-x, C-c, and C-v for undo, cut, copy, and paste. | |
265 | If the value is t, these mappings are always enabled. If the value is | |
266 | 'shift, these keys are only enabled if the last region was marked with | |
267 | a shifted movement key. If the value is nil, these keys are never | |
268 | enabled." | |
a1506d29 | 269 | :type '(choice (const :tag "Disabled" nil) |
72cc582e | 270 | (const :tag "Shift region only" shift) |
c1cdea1a | 271 | (other :tag "Enabled" t)) |
72cc582e KS |
272 | :group 'cua) |
273 | ||
274 | (defcustom cua-highlight-region-shift-only nil | |
275 | "*If non-nil, only highlight region if marked with S-<move>. | |
276 | When this is non-nil, CUA toggles `transient-mark-mode' on when the region | |
277 | is marked using shifted movement keys, and off when the mark is cleared. | |
278 | But when the mark was set using \\[cua-set-mark], transient-mark-mode | |
279 | is not turned on." | |
280 | :type 'boolean | |
281 | :group 'cua) | |
282 | ||
a1506d29 | 283 | (defcustom cua-prefix-override-inhibit-delay |
72cc582e KS |
284 | (if (featurep 'lisp-float-type) (/ (float 1) (float 5)) nil) |
285 | "*If non-nil, time in seconds to delay before overriding prefix key. | |
286 | If there is additional input within this time, the prefix key is | |
287 | used as a normal prefix key. So typing a key sequence quickly will | |
288 | inhibit overriding the prefix key. | |
289 | As a special case, if the prefix keys repeated within this time, the | |
290 | first prefix key is discarded, so typing a prefix key twice in quick | |
291 | succession will also inhibit overriding the prefix key. | |
292 | If the value is nil, use a shifted prefix key to inhibit the override." | |
293 | :type '(choice (number :tag "Inhibit delay") | |
294 | (const :tag "No delay" nil)) | |
295 | :group 'cua) | |
296 | ||
297 | (defcustom cua-keep-region-after-copy nil | |
298 | "If non-nil, don't deselect the region after copying." | |
299 | :type 'boolean | |
300 | :group 'cua) | |
301 | ||
302 | (defcustom cua-enable-register-prefix 'not-ctrl-u | |
303 | "*If non-nil, registers are supported via numeric prefix arg. | |
304 | If the value is t, any numeric prefix arg in the range 0 to 9 will be | |
a1506d29 | 305 | interpreted as a register number. |
72cc582e | 306 | If the value is not-ctrl-u, using C-u to enter a numeric prefix is not |
a1506d29 | 307 | interpreted as a register number. |
72cc582e KS |
308 | If the value is ctrl-u-only, only numeric prefix entered with C-u is |
309 | interpreted as a register number." | |
a1506d29 | 310 | :type '(choice (const :tag "Disabled" nil) |
72cc582e KS |
311 | (const :tag "Enabled, but C-u arg is not a register" not-ctrl-u) |
312 | (const :tag "Enabled, but only for C-u arg" ctrl-u-only) | |
c1cdea1a | 313 | (other :tag "Enabled" t)) |
72cc582e KS |
314 | :group 'cua) |
315 | ||
316 | (defcustom cua-delete-copy-to-register-0 t | |
317 | "*If non-nil, save last deleted region or rectangle to register 0." | |
318 | :type 'boolean | |
319 | :group 'cua) | |
320 | ||
321 | (defcustom cua-use-hyper-key nil | |
322 | "*If non-nil, bind rectangle commands to H-? instead of M-?. | |
323 | If set to 'also, toggle region command is also on S-return. | |
324 | Must be set prior to enabling CUA." | |
325 | :type '(choice (const :tag "Meta key and S-return" nil) | |
326 | (const :tag "Hyper key only" only) | |
327 | (const :tag "Hyper key and S-return" also)) | |
328 | :group 'cua) | |
329 | ||
330 | (defcustom cua-enable-region-auto-help nil | |
331 | "*If non-nil, automatically show help for active region." | |
332 | :type 'boolean | |
333 | :group 'cua) | |
334 | ||
335 | (defcustom cua-enable-modeline-indications nil | |
336 | "*If non-nil, use minor-mode hook to show status in mode line." | |
337 | :type 'boolean | |
338 | :group 'cua) | |
339 | ||
340 | (defcustom cua-check-pending-input t | |
341 | "*If non-nil, don't override prefix key if input pending. | |
342 | It is rumoured that input-pending-p is unreliable under some window | |
343 | managers, so try setting this to nil, if prefix override doesn't work." | |
344 | :type 'boolean | |
345 | :group 'cua) | |
346 | ||
347 | ||
348 | ;;; Rectangle Customization | |
349 | ||
350 | (defcustom cua-auto-expand-rectangles nil | |
351 | "*If non-nil, rectangles are padded with spaces to make straight edges. | |
352 | This implies modifying buffer contents by expanding tabs and inserting spaces. | |
353 | Consequently, this is inhibited in read-only buffers. | |
354 | Can be toggled by [M-p] while the rectangle is active," | |
355 | :type 'boolean | |
356 | :group 'cua) | |
357 | ||
358 | (defcustom cua-enable-rectangle-auto-help t | |
359 | "*If non-nil, automatically show help for region, rectangle and global mark." | |
360 | :type 'boolean | |
361 | :group 'cua) | |
362 | ||
363 | (defface cua-rectangle-face 'nil | |
364 | "*Font used by CUA for highlighting the rectangle." | |
365 | :group 'cua) | |
366 | ||
367 | (defface cua-rectangle-noselect-face 'nil | |
368 | "*Font used by CUA for highlighting the non-selected rectangle lines." | |
369 | :group 'cua) | |
370 | ||
371 | (defcustom cua-undo-max 64 | |
372 | "*Max no of undoable CUA rectangle changes (including undo)." | |
373 | :type 'integer | |
374 | :group 'cua) | |
375 | ||
376 | ||
377 | ;;; Global Mark Customization | |
378 | ||
379 | (defcustom cua-global-mark-keep-visible t | |
380 | "*If non-nil, always keep global mark visible in other window." | |
381 | :type 'boolean | |
382 | :group 'cua) | |
383 | ||
a1506d29 | 384 | (defface cua-global-mark-face '((((class color)) |
80d9508a SM |
385 | :foreground "black" |
386 | :background "yellow") | |
387 | (t :bold t)) | |
72cc582e KS |
388 | "*Font used by CUA for highlighting the global mark." |
389 | :group 'cua) | |
390 | ||
391 | (defcustom cua-global-mark-blink-cursor-interval 0.20 | |
392 | "*Blink cursor at this interval when global mark is active." | |
393 | :type '(choice (number :tag "Blink interval") | |
394 | (const :tag "No blink" nil)) | |
395 | :group 'cua) | |
396 | ||
397 | ||
398 | ;;; Cursor Indication Customization | |
399 | ||
cadc926b | 400 | (defcustom cua-enable-cursor-indications nil |
72cc582e KS |
401 | "*If non-nil, use different cursor colors for indications." |
402 | :type 'boolean | |
403 | :group 'cua) | |
404 | ||
496c17d6 KS |
405 | (defcustom cua-normal-cursor-color (or (and (boundp 'initial-cursor-color) initial-cursor-color) |
406 | (and (boundp 'initial-frame-alist) | |
407 | (assoc 'cursor-color initial-frame-alist) | |
408 | (cdr (assoc 'cursor-color initial-frame-alist))) | |
409 | (and (boundp 'default-frame-alist) | |
410 | (assoc 'cursor-color default-frame-alist) | |
411 | (cdr (assoc 'cursor-color default-frame-alist))) | |
412 | (frame-parameter nil 'cursor-color) | |
413 | "red") | |
72cc582e KS |
414 | "Normal (non-overwrite) cursor color. |
415 | Also used to indicate that rectangle padding is not in effect. | |
496c17d6 KS |
416 | Default is to load cursor color from initial or default frame parameters." |
417 | :initialize 'custom-initialize-default | |
72cc582e KS |
418 | :type 'color |
419 | :group 'cua) | |
420 | ||
421 | (defcustom cua-read-only-cursor-color "darkgreen" | |
6b61353c KH |
422 | "*Cursor color used in read-only buffers, if non-nil. |
423 | Only used when `cua-enable-cursor-indications' is non-nil." | |
72cc582e KS |
424 | :type 'color |
425 | :group 'cua) | |
426 | ||
427 | (defcustom cua-overwrite-cursor-color "yellow" | |
428 | "*Cursor color used when overwrite mode is set, if non-nil. | |
6b61353c KH |
429 | Also used to indicate that rectangle padding is in effect. |
430 | Only used when `cua-enable-cursor-indications' is non-nil." | |
72cc582e KS |
431 | :type 'color |
432 | :group 'cua) | |
433 | ||
434 | (defcustom cua-global-mark-cursor-color "cyan" | |
435 | "*Indication for active global mark. | |
6b61353c KH |
436 | Will change cursor color to specified color if string. |
437 | Only used when `cua-enable-cursor-indications' is non-nil." | |
72cc582e KS |
438 | :type 'color |
439 | :group 'cua) | |
440 | ||
441 | ||
442 | ;;; Rectangle support is in cua-rect.el | |
443 | ||
444 | (autoload 'cua-set-rectangle-mark "cua-rect" nil t nil) | |
445 | ||
446 | ;; Stub definitions until it is loaded | |
447 | ||
448 | (when (not (featurep 'cua-rect)) | |
449 | (defvar cua--rectangle) | |
450 | (setq cua--rectangle nil) | |
451 | (defvar cua--last-killed-rectangle) | |
452 | (setq cua--last-killed-rectangle nil)) | |
453 | ||
454 | ||
455 | ||
456 | ;;; Global Mark support is in cua-gmrk.el | |
457 | ||
458 | (autoload 'cua-toggle-global-mark "cua-gmrk.el" nil t nil) | |
459 | ||
460 | ;; Stub definitions until cua-gmrk.el is loaded | |
461 | ||
462 | (when (not (featurep 'cua-gmrk)) | |
463 | (defvar cua--global-mark-active) | |
464 | (setq cua--global-mark-active nil)) | |
465 | ||
466 | ||
467 | (provide 'cua-base) | |
468 | ||
469 | (eval-when-compile | |
470 | (require 'cua-rect) | |
471 | (require 'cua-gmrk) | |
472 | ) | |
473 | ||
63e6f5b3 KS |
474 | |
475 | ;;; Low-level Interface | |
476 | ||
477 | (defvar cua-inhibit-cua-keys nil | |
478 | "Buffer-local variable that may disable the cua keymappings.") | |
479 | (make-variable-buffer-local 'cua-inhibit-cua-keys) | |
480 | ||
72cc582e KS |
481 | ;;; Aux. variables |
482 | ||
483 | ;; Current region was started using cua-set-mark. | |
484 | (defvar cua--explicit-region-start nil) | |
485 | ||
486 | ;; Latest region was started using shifted movement command. | |
487 | (defvar cua--last-region-shifted nil) | |
488 | ||
489 | ;; buffer + point prior to current command when rectangle is active | |
490 | ;; checked in post-command hook to see if point was moved | |
491 | (defvar cua--buffer-and-point-before-command nil) | |
492 | ||
493 | ;; status string for mode line indications | |
494 | (defvar cua--status-string nil) | |
495 | ||
496 | (defvar cua--debug nil) | |
497 | ||
498 | ||
499 | ;;; Prefix key override mechanism | |
500 | ||
501 | ;; The prefix override (when mark-active) operates in three substates: | |
502 | ;; [1] Before using a prefix key | |
503 | ;; [2] Immediately after using a prefix key | |
504 | ;; [3] A fraction of a second later | |
505 | ||
506 | ;; In state [1], the cua--prefix-override-keymap is active. | |
507 | ;; This keymap binds the C-x and C-c prefix keys to the | |
508 | ;; cua--prefix-override-handler function. | |
509 | ||
510 | ;; When a prefix key is typed in state [1], cua--prefix-override-handler | |
511 | ;; will push back the keys already read to the event queue. If input is | |
512 | ;; pending, it changes directly to state [3]. Otherwise, a short timer [T] | |
513 | ;; is started, and it changes to state [2]. | |
514 | ||
515 | ;; In state [2], the cua--prefix-override-keymap is inactive. Instead the | |
516 | ;; cua--prefix-repeat-keymap is active. This keymap binds C-c C-c and C-x | |
517 | ;; C-x to the cua--prefix-repeat-handler function. | |
518 | ||
519 | ;; If the prefix key is repeated in state [2], cua--prefix-repeat-handler | |
520 | ;; will cancel [T], back the keys already read (except for the second prefix | |
521 | ;; keys) to the event queue, and changes to state [3]. | |
522 | ||
523 | ;; The basic cua--cua-keys-keymap binds [C-x timeout] to kill-region and | |
524 | ;; [C-c timeout] to copy-region-as-kill, so if [T] times out in state [2], | |
525 | ;; the cua--prefix-override-timeout function will push a `timeout' event on | |
526 | ;; the event queue, and changes to state [3]. | |
527 | ||
528 | ;; In state [3] both cua--prefix-override-keymap and cua--prefix-repeat-keymap | |
529 | ;; are inactive, so the timeout in cua-global-keymap binding is used, or the | |
530 | ;; normal prefix key binding from the global or local map will be used. | |
531 | ||
532 | ;; The pre-command hook (executed as a consequence of the timeout or normal | |
533 | ;; prefix key binding) will cancel [T] and change from state [3] back to | |
534 | ;; state [1]. So cua--prefix-override-handler and cua--prefix-repeat-handler | |
535 | ;; are always called with state reset to [1]! | |
536 | ||
537 | ;; State [1] is recognized by cua--prefix-override-timer is nil, | |
538 | ;; state [2] is recognized by cua--prefix-override-timer is a timer, and | |
539 | ;; state [3] is recognized by cua--prefix-override-timer is t. | |
540 | ||
541 | (defvar cua--prefix-override-timer nil) | |
542 | (defvar cua--prefix-override-length nil) | |
543 | ||
544 | (defun cua--prefix-override-replay (arg repeat) | |
545 | (let* ((keys (this-command-keys)) | |
546 | (i (length keys)) | |
547 | (key (aref keys (1- i)))) | |
548 | (setq cua--prefix-override-length (- i repeat)) | |
549 | (setq cua--prefix-override-timer | |
550 | (or | |
551 | ;; In state [2], change to state [3] | |
552 | (> repeat 0) | |
553 | ;; In state [1], change directly to state [3] | |
554 | (and cua-check-pending-input (input-pending-p)) | |
555 | ;; In state [1], [T] disabled, so change to state [3] | |
556 | (not (numberp cua-prefix-override-inhibit-delay)) | |
557 | (<= cua-prefix-override-inhibit-delay 0) | |
558 | ;; In state [1], start [T] and change to state [2] | |
a1506d29 | 559 | (run-with-timer cua-prefix-override-inhibit-delay nil |
72cc582e KS |
560 | 'cua--prefix-override-timeout))) |
561 | ;; Don't record this command | |
562 | (setq this-command last-command) | |
563 | ;; Restore the prefix arg | |
564 | (setq prefix-arg arg) | |
565 | (reset-this-command-lengths) | |
566 | ;; Push the key back on the event queue | |
567 | (setq unread-command-events (cons key unread-command-events)))) | |
568 | ||
569 | (defun cua--prefix-override-handler (arg) | |
570 | "Start timer waiting for prefix key to be followed by another key. | |
571 | Repeating prefix key when region is active works as a single prefix key." | |
572 | (interactive "P") | |
573 | (cua--prefix-override-replay arg 0)) | |
574 | ||
575 | (defun cua--prefix-repeat-handler (arg) | |
576 | "Repeating prefix key when region is active works as a single prefix key." | |
577 | (interactive "P") | |
578 | (cua--prefix-override-replay arg 1)) | |
579 | ||
580 | (defun cua--prefix-copy-handler (arg) | |
581 | "Copy region/rectangle, then replay last key." | |
582 | (interactive "P") | |
583 | (if cua--rectangle | |
584 | (cua-copy-rectangle arg) | |
585 | (cua-copy-region arg)) | |
586 | (let ((keys (this-single-command-keys))) | |
a1506d29 | 587 | (setq unread-command-events |
72cc582e KS |
588 | (cons (aref keys (1- (length keys))) unread-command-events)))) |
589 | ||
590 | (defun cua--prefix-cut-handler (arg) | |
591 | "Cut region/rectangle, then replay last key." | |
592 | (interactive "P") | |
593 | (if cua--rectangle | |
594 | (cua-cut-rectangle arg) | |
595 | (cua-cut-region arg)) | |
596 | (let ((keys (this-single-command-keys))) | |
a1506d29 | 597 | (setq unread-command-events |
72cc582e KS |
598 | (cons (aref keys (1- (length keys))) unread-command-events)))) |
599 | ||
600 | (defun cua--prefix-override-timeout () | |
601 | (setq cua--prefix-override-timer t) | |
602 | (when (= (length (this-command-keys)) cua--prefix-override-length) | |
603 | (setq unread-command-events (cons 'timeout unread-command-events)) | |
604 | (if prefix-arg | |
605 | (reset-this-command-lengths) | |
606 | (setq overriding-terminal-local-map nil)) | |
a23a8440 | 607 | (cua--select-keymaps))) |
72cc582e KS |
608 | |
609 | ||
610 | ;;; Aux. functions | |
611 | ||
612 | (defun cua--fallback () | |
613 | ;; Execute original command | |
614 | (setq this-command this-original-command) | |
615 | (call-interactively this-command)) | |
a1506d29 | 616 | |
72cc582e KS |
617 | (defun cua--keep-active () |
618 | (setq mark-active t | |
619 | deactivate-mark nil)) | |
620 | ||
621 | (defun cua--deactivate (&optional now) | |
622 | (setq cua--explicit-region-start nil) | |
623 | (if (not now) | |
624 | (setq deactivate-mark t) | |
625 | (setq mark-active nil) | |
626 | (run-hooks 'deactivate-mark-hook))) | |
627 | ||
628 | ||
629 | ;; The current register prefix | |
630 | (defvar cua--register nil) | |
631 | ||
632 | (defun cua--prefix-arg (arg) | |
a1506d29 | 633 | (setq cua--register |
72cc582e | 634 | (and cua-enable-register-prefix |
72cc582e | 635 | (integerp arg) (>= arg 0) (< arg 10) |
1c62c12f KS |
636 | (let* ((prefix (aref (this-command-keys) 0)) |
637 | (ctrl-u-prefix (and (integerp prefix) | |
5632c006 | 638 | (= prefix ?\C-u)))) |
a1506d29 | 639 | (cond |
5632c006 KS |
640 | ((eq cua-enable-register-prefix 'not-ctrl-u) |
641 | (not ctrl-u-prefix)) | |
642 | ((eq cua-enable-register-prefix 'ctrl-u-only) | |
643 | ctrl-u-prefix) | |
644 | (t t))) | |
72cc582e KS |
645 | (+ arg ?0))) |
646 | (if cua--register nil arg)) | |
647 | ||
72cc582e KS |
648 | ;;; Enhanced undo - restore rectangle selections |
649 | ||
650 | (defun cua-undo (&optional arg) | |
651 | "Undo some previous changes. | |
652 | Knows about CUA rectangle highlighting in addition to standard undo." | |
653 | (interactive "*P") | |
654 | (if (fboundp 'cua--rectangle-undo) | |
655 | (cua--rectangle-undo arg) | |
656 | (undo arg))) | |
657 | ||
658 | ;;; Region specific commands | |
659 | ||
5834ac92 KS |
660 | (defvar cua--last-deleted-region-pos nil) |
661 | (defvar cua--last-deleted-region-text nil) | |
662 | ||
72cc582e KS |
663 | (defun cua-delete-region () |
664 | "Delete the active region. | |
665 | Save a copy in register 0 if `cua-delete-copy-to-register-0' is non-nil." | |
666 | (interactive) | |
667 | (let ((start (mark)) (end (point))) | |
668 | (or (<= start end) | |
669 | (setq start (prog1 end (setq end start)))) | |
5834ac92 | 670 | (setq cua--last-deleted-region-text (buffer-substring start end)) |
72cc582e | 671 | (if cua-delete-copy-to-register-0 |
5834ac92 | 672 | (set-register ?0 cua--last-deleted-region-text)) |
72cc582e | 673 | (delete-region start end) |
a1506d29 | 674 | (setq cua--last-deleted-region-pos |
5834ac92 KS |
675 | (cons (current-buffer) |
676 | (and (consp buffer-undo-list) | |
677 | (car buffer-undo-list)))) | |
72cc582e KS |
678 | (cua--deactivate))) |
679 | ||
680 | (defun cua-replace-region () | |
681 | "Replace the active region with the character you type." | |
682 | (interactive) | |
683 | (cua-delete-region) | |
5834ac92 KS |
684 | (unless (eq this-original-command this-command) |
685 | (cua--fallback))) | |
72cc582e KS |
686 | |
687 | (defun cua-copy-region (arg) | |
688 | "Copy the region to the kill ring. | |
689 | With numeric prefix arg, copy to register 0-9 instead." | |
690 | (interactive "P") | |
691 | (setq arg (cua--prefix-arg arg)) | |
692 | (setq cua--last-killed-rectangle nil) | |
693 | (let ((start (mark)) (end (point))) | |
694 | (or (<= start end) | |
695 | (setq start (prog1 end (setq end start)))) | |
696 | (if cua--register | |
697 | (copy-to-register cua--register start end nil) | |
698 | (copy-region-as-kill start end)) | |
699 | (if cua-keep-region-after-copy | |
700 | (cua--keep-active) | |
701 | (cua--deactivate)))) | |
702 | ||
703 | (defun cua-cut-region (arg) | |
704 | "Cut the region and copy to the kill ring. | |
705 | With numeric prefix arg, copy to register 0-9 instead." | |
706 | (interactive "P") | |
707 | (setq cua--last-killed-rectangle nil) | |
708 | (if buffer-read-only | |
709 | (cua-copy-region arg) | |
710 | (setq arg (cua--prefix-arg arg)) | |
711 | (let ((start (mark)) (end (point))) | |
712 | (or (<= start end) | |
713 | (setq start (prog1 end (setq end start)))) | |
714 | (if cua--register | |
715 | (copy-to-register cua--register start end t) | |
716 | (kill-region start end))) | |
717 | (cua--deactivate))) | |
718 | ||
719 | ;;; Generic commands for regions, rectangles, and global marks | |
720 | ||
721 | (defun cua-cancel () | |
722 | "Cancel the active region, rectangle, or global mark." | |
723 | (interactive) | |
724 | (setq mark-active nil) | |
725 | (setq cua--explicit-region-start nil) | |
726 | (if (fboundp 'cua--cancel-rectangle) | |
727 | (cua--cancel-rectangle))) | |
728 | ||
729 | (defun cua-paste (arg) | |
730 | "Paste last cut or copied region or rectangle. | |
731 | An active region is deleted before executing the command. | |
732 | With numeric prefix arg, paste from register 0-9 instead. | |
733 | If global mark is active, copy from register or one character." | |
734 | (interactive "P") | |
735 | (setq arg (cua--prefix-arg arg)) | |
736 | (let ((regtxt (and cua--register (get-register cua--register))) | |
737 | (count (prefix-numeric-value arg))) | |
738 | (cond | |
739 | ((and cua--register (not regtxt)) | |
740 | (message "Nothing in register %c" cua--register)) | |
741 | (cua--global-mark-active | |
742 | (if regtxt | |
743 | (cua--insert-at-global-mark regtxt) | |
744 | (when (not (eobp)) | |
745 | (cua--insert-at-global-mark (buffer-substring (point) (+ (point) count))) | |
746 | (forward-char count)))) | |
747 | (buffer-read-only | |
748 | (message "Cannot paste into a read-only buffer")) | |
749 | (t | |
750 | ;; Must save register here, since delete may override reg 0. | |
751 | (if mark-active | |
752 | ;; Before a yank command, make sure we don't yank | |
753 | ;; the same region that we are going to delete. | |
754 | ;; That would make yank a no-op. | |
755 | (if cua--rectangle | |
756 | (cua--delete-rectangle) | |
757 | (if (string= (buffer-substring (point) (mark)) | |
758 | (car kill-ring)) | |
759 | (current-kill 1)) | |
760 | (cua-delete-region))) | |
761 | (cond | |
762 | (regtxt | |
763 | (cond | |
764 | ((consp regtxt) (cua--insert-rectangle regtxt)) | |
765 | ((stringp regtxt) (insert-for-yank regtxt)) | |
766 | (t (message "Unknown data in register %c" cua--register)))) | |
767 | ((and cua--last-killed-rectangle | |
768 | (eq (and kill-ring (car kill-ring)) (car cua--last-killed-rectangle))) | |
769 | (let ((pt (point))) | |
770 | (when (not (eq buffer-undo-list t)) | |
771 | (setq this-command 'cua--paste-rectangle) | |
772 | (undo-boundary) | |
773 | (setq buffer-undo-list (cons pt buffer-undo-list))) | |
774 | (cua--insert-rectangle (cdr cua--last-killed-rectangle)) | |
775 | (if arg (goto-char pt)))) | |
776 | (t (yank arg))))))) | |
777 | ||
778 | (defun cua-paste-pop (arg) | |
779 | "Replace a just-pasted text or rectangle with a different text. | |
780 | See `yank-pop' for details." | |
781 | (interactive "P") | |
782 | (if (eq last-command 'cua--paste-rectangle) | |
783 | (progn | |
784 | (undo) | |
785 | (yank arg)) | |
786 | (yank-pop (prefix-numeric-value arg)))) | |
787 | ||
788 | (defun cua-exchange-point-and-mark (arg) | |
789 | "Exchanges point and mark, but don't activate the mark. | |
790 | Activates the mark if a prefix argument is given." | |
791 | (interactive "P") | |
792 | (if arg | |
793 | (setq mark-active t) | |
794 | (let (mark-active) | |
795 | (exchange-point-and-mark) | |
796 | (if cua--rectangle | |
797 | (cua--rectangle-corner 0))))) | |
798 | ||
34a63289 KS |
799 | ;; Typed text that replaced the highlighted region. |
800 | (defvar cua--repeat-replace-text nil) | |
801 | ||
802 | (defun cua-repeat-replace-region (arg) | |
803 | "Repeat replacing text of highlighted region with typed text. | |
804 | Searches for the next streach of text identical to the region last | |
805 | replaced by typing text over it and replaces it with the same streach | |
5834ac92 | 806 | of text." |
34a63289 | 807 | (interactive "P") |
5834ac92 KS |
808 | (when cua--last-deleted-region-pos |
809 | (save-excursion | |
810 | (save-restriction | |
811 | (set-buffer (car cua--last-deleted-region-pos)) | |
812 | (widen) | |
813 | ;; Find the text that replaced the region via the undo list. | |
814 | (let ((ul buffer-undo-list) | |
815 | (elt (cdr cua--last-deleted-region-pos)) | |
816 | u s e) | |
817 | (when elt | |
818 | (while (consp ul) | |
819 | (setq u (car ul) ul (cdr ul)) | |
820 | (cond | |
821 | ((eq u elt) ;; got it | |
822 | (setq ul nil)) | |
823 | ((and (consp u) (integerp (car u)) (integerp (cdr u))) | |
824 | (if (and s (= (cdr u) s)) | |
825 | (setq s (car u)) | |
826 | (setq s (car u) e (cdr u))))))) | |
827 | (setq cua--repeat-replace-text | |
828 | (cond ((and s e (<= s e) (= s (mark t))) | |
829 | (buffer-substring-no-properties s e)) | |
830 | ((and (null s) (eq u elt)) ;; nothing inserted | |
831 | "") | |
832 | (t | |
833 | (message "Cannot locate replacement text") | |
834 | nil)))))) | |
835 | (setq cua--last-deleted-region-pos nil)) | |
836 | (if (and cua--last-deleted-region-text | |
837 | cua--repeat-replace-text | |
838 | (search-forward cua--last-deleted-region-text nil t nil)) | |
839 | (replace-match cua--repeat-replace-text arg t))) | |
34a63289 | 840 | |
72cc582e KS |
841 | (defun cua-help-for-region (&optional help) |
842 | "Show region specific help in echo area." | |
843 | (interactive) | |
a1506d29 | 844 | (message |
72cc582e KS |
845 | (concat (if help "C-?:help " "") |
846 | "C-z:undo C-x:cut C-c:copy C-v:paste S-ret:rect"))) | |
847 | ||
848 | ||
849 | ;;; Shift activated / extended region | |
850 | ||
851 | (defun cua-set-mark (&optional arg) | |
852 | "Set mark at where point is, clear mark, or jump to mark. | |
f45a6831 KS |
853 | |
854 | With no prefix argument, clear mark if already set. Otherwise, set | |
855 | mark, and push old mark position on local mark ring; also push mark on | |
6b61353c | 856 | global mark ring if last mark was set in another buffer. |
f45a6831 KS |
857 | |
858 | With argument, jump to mark, and pop a new position for mark off | |
859 | the local mark ring \(this does not affect the global mark ring\). | |
860 | Use \\[pop-global-mark] to jump to a mark off the global mark ring | |
ce92443f KS |
861 | \(see `pop-global-mark'\). |
862 | ||
863 | Repeating the command without the prefix jumps to the next position | |
864 | off the local \(or global\) mark ring. | |
f45a6831 KS |
865 | |
866 | With a double \\[universal-argument] prefix argument, unconditionally set mark." | |
72cc582e | 867 | (interactive "P") |
72cc582e | 868 | (cond |
f45a6831 KS |
869 | ((and (consp arg) (> (prefix-numeric-value arg) 4)) |
870 | (push-mark-command nil)) | |
fc803e8d | 871 | ((eq last-command 'pop-to-mark-command) |
f45a6831 KS |
872 | (setq this-command 'pop-to-mark-command) |
873 | (pop-to-mark-command)) | |
ce92443f | 874 | ((and (eq last-command 'pop-global-mark) (not arg)) |
f45a6831 KS |
875 | (setq this-command 'pop-global-mark) |
876 | (pop-global-mark)) | |
72cc582e | 877 | (arg |
fc803e8d KS |
878 | (setq this-command 'pop-to-mark-command) |
879 | (pop-to-mark-command)) | |
72cc582e KS |
880 | (mark-active |
881 | (cua--deactivate) | |
882 | (message "Mark Cleared")) | |
883 | (t | |
fc803e8d | 884 | (push-mark-command nil nil) |
72cc582e KS |
885 | (setq cua--explicit-region-start t) |
886 | (setq cua--last-region-shifted nil) | |
887 | (if cua-enable-region-auto-help | |
888 | (cua-help-for-region t))))) | |
889 | ||
890 | (defvar cua--standard-movement-commands | |
891 | '(forward-char backward-char | |
892 | next-line previous-line | |
893 | forward-word backward-word | |
894 | end-of-line beginning-of-line | |
895 | end-of-buffer beginning-of-buffer | |
6b61353c KH |
896 | scroll-up scroll-down |
897 | forward-sentence backward-sentence | |
898 | forward-paragraph backward-paragraph) | |
72cc582e | 899 | "List of standard movement commands. |
9715510b | 900 | Extra commands should be added to `cua-movement-commands'") |
72cc582e KS |
901 | |
902 | (defvar cua-movement-commands nil | |
903 | "User may add additional movement commands to this list.") | |
904 | ||
905 | ||
906 | ;;; Cursor indications | |
907 | ||
908 | (defun cua--update-indications () | |
909 | (let ((cursor | |
910 | (cond | |
911 | ((and cua--global-mark-active | |
912 | (stringp cua-global-mark-cursor-color)) | |
913 | cua-global-mark-cursor-color) | |
914 | ((and buffer-read-only | |
915 | (stringp cua-read-only-cursor-color)) | |
916 | cua-read-only-cursor-color) | |
917 | ((and (stringp cua-overwrite-cursor-color) | |
918 | (or overwrite-mode | |
919 | (and cua--rectangle (cua--rectangle-padding)))) | |
920 | cua-overwrite-cursor-color) | |
921 | (t cua-normal-cursor-color)))) | |
922 | (if (and cursor | |
923 | (not (equal cursor (frame-parameter nil 'cursor-color)))) | |
924 | (set-cursor-color cursor)) | |
925 | cursor)) | |
926 | ||
927 | ||
928 | ;;; Pre-command hook | |
929 | ||
930 | (defun cua--pre-command-handler () | |
931 | (condition-case nil | |
932 | (let ((movement (or (memq this-command cua--standard-movement-commands) | |
933 | (memq this-command cua-movement-commands)))) | |
934 | ||
935 | ;; Cancel prefix key timeout if user enters another key. | |
936 | (when cua--prefix-override-timer | |
937 | (if (timerp cua--prefix-override-timer) | |
938 | (cancel-timer cua--prefix-override-timer)) | |
939 | (setq cua--prefix-override-timer nil)) | |
940 | ||
941 | ;; Handle shifted cursor keys and other movement commands. | |
942 | ;; If region is not active, region is activated if key is shifted. | |
943 | ;; If region is active, region is cancelled if key is unshifted (and region not started with C-SPC). | |
944 | ;; If rectangle is active, expand rectangle in specified direction and ignore the movement. | |
945 | (if movement | |
946 | (cond | |
947 | ((memq 'shift (event-modifiers (aref (this-single-command-raw-keys) 0))) | |
948 | (unless mark-active | |
fc803e8d | 949 | (push-mark-command nil t)) |
72cc582e KS |
950 | (setq cua--last-region-shifted t) |
951 | (setq cua--explicit-region-start nil)) | |
952 | ((or cua--explicit-region-start cua--rectangle) | |
953 | (unless mark-active | |
fc803e8d | 954 | (push-mark-command nil nil))) |
72cc582e | 955 | (t |
a1506d29 | 956 | ;; If we set mark-active to nil here, the region highlight will not be |
72cc582e KS |
957 | ;; removed by the direct_output_ commands. |
958 | (setq deactivate-mark t))) | |
959 | ||
960 | ;; Handle delete-selection property on other commands | |
e75d337c KS |
961 | (if (and mark-active (not deactivate-mark)) |
962 | (let* ((ds (or (get this-command 'delete-selection) | |
963 | (get this-command 'pending-delete))) | |
964 | (nc (cond | |
965 | ((not ds) nil) | |
a1506d29 | 966 | ((eq ds 'yank) |
e75d337c KS |
967 | 'cua-paste) |
968 | ((eq ds 'kill) | |
969 | (if cua--rectangle | |
970 | 'cua-copy-rectangle | |
971 | 'cua-copy-region)) | |
972 | ((eq ds 'supersede) | |
973 | (if cua--rectangle | |
ad9de65b KS |
974 | 'cua-delete-rectangle |
975 | 'cua-delete-region)) | |
e75d337c KS |
976 | (t |
977 | (if cua--rectangle | |
ad9de65b KS |
978 | 'cua-delete-rectangle ;; replace? |
979 | 'cua-replace-region))))) | |
e75d337c KS |
980 | (if nc |
981 | (setq this-original-command this-command | |
982 | this-command nc))))) | |
a1506d29 | 983 | |
72cc582e | 984 | ;; Detect extension of rectangles by mouse or other movement |
a1506d29 | 985 | (setq cua--buffer-and-point-before-command |
72cc582e KS |
986 | (if cua--rectangle (cons (current-buffer) (point)))) |
987 | ) | |
988 | (error nil))) | |
989 | ||
990 | ;;; Post-command hook | |
991 | ||
992 | (defun cua--post-command-handler () | |
993 | (condition-case nil | |
994 | (progn | |
995 | (when cua--global-mark-active | |
996 | (cua--global-mark-post-command)) | |
997 | (when (fboundp 'cua--rectangle-post-command) | |
998 | (cua--rectangle-post-command)) | |
999 | (setq cua--buffer-and-point-before-command nil) | |
1000 | (if (or (not mark-active) deactivate-mark) | |
1001 | (setq cua--explicit-region-start nil)) | |
1002 | ||
1003 | ;; Debugging | |
1004 | (if cua--debug | |
a1506d29 | 1005 | (cond |
72cc582e KS |
1006 | (cua--rectangle (cua--rectangle-assert)) |
1007 | (mark-active (message "Mark=%d Point=%d Expl=%s" | |
1008 | (mark t) (point) cua--explicit-region-start)))) | |
1009 | ||
1010 | ;; Disable transient-mark-mode if rectangle active in current buffer. | |
1011 | (if (not (window-minibuffer-p (selected-window))) | |
1012 | (setq transient-mark-mode (and (not cua--rectangle) | |
1013 | (if cua-highlight-region-shift-only | |
1014 | (not cua--explicit-region-start) | |
1015 | t)))) | |
1016 | (if cua-enable-cursor-indications | |
1017 | (cua--update-indications)) | |
1018 | ||
a23a8440 | 1019 | (cua--select-keymaps) |
72cc582e KS |
1020 | ) |
1021 | ||
1022 | (error nil))) | |
1023 | ||
1024 | ||
1025 | ;;; Keymaps | |
1026 | ||
1027 | (defun cua--M/H-key (map key fct) | |
1028 | ;; bind H-KEY or M-KEY to FCT in MAP | |
1029 | (if (eq key 'space) (setq key ? )) | |
1030 | (unless (listp key) (setq key (list key))) | |
1031 | (define-key map (vector (cons (if cua-use-hyper-key 'hyper 'meta) key)) fct)) | |
1032 | ||
20023b9c KS |
1033 | (defun cua--self-insert-char-p (def) |
1034 | ;; Return DEF if current key sequence is self-inserting in | |
1035 | ;; global-map. | |
1036 | (if (memq (global-key-binding (this-single-command-keys)) | |
1037 | '(self-insert-command self-insert-iso)) | |
1038 | def nil)) | |
1039 | ||
a23a8440 KS |
1040 | (defvar cua-global-keymap (make-sparse-keymap) |
1041 | "Global keymap for cua-mode; users may add to this keymap.") | |
1042 | ||
72cc582e KS |
1043 | (defvar cua--cua-keys-keymap (make-sparse-keymap)) |
1044 | (defvar cua--prefix-override-keymap (make-sparse-keymap)) | |
1045 | (defvar cua--prefix-repeat-keymap (make-sparse-keymap)) | |
1046 | (defvar cua--global-mark-keymap (make-sparse-keymap)) ; Initalized when cua-gmrk.el is loaded | |
1047 | (defvar cua--rectangle-keymap (make-sparse-keymap)) ; Initalized when cua-rect.el is loaded | |
1048 | (defvar cua--region-keymap (make-sparse-keymap)) | |
1049 | ||
1050 | (defvar cua--ena-cua-keys-keymap nil) | |
1051 | (defvar cua--ena-prefix-override-keymap nil) | |
1052 | (defvar cua--ena-prefix-repeat-keymap nil) | |
1053 | (defvar cua--ena-region-keymap nil) | |
1054 | (defvar cua--ena-global-mark-keymap nil) | |
1055 | ||
a23a8440 KS |
1056 | (defvar cua--keymap-alist |
1057 | `((cua--ena-prefix-override-keymap . ,cua--prefix-override-keymap) | |
1058 | (cua--ena-prefix-repeat-keymap . ,cua--prefix-repeat-keymap) | |
1059 | (cua--ena-cua-keys-keymap . ,cua--cua-keys-keymap) | |
1060 | (cua--ena-global-mark-keymap . ,cua--global-mark-keymap) | |
1061 | (cua--rectangle . ,cua--rectangle-keymap) | |
1062 | (cua--ena-region-keymap . ,cua--region-keymap) | |
1063 | (cua-mode . ,cua-global-keymap))) | |
1064 | ||
1065 | (defun cua--select-keymaps () | |
1066 | ;; Setup conditions for selecting the proper keymaps in cua--keymap-alist. | |
72cc582e KS |
1067 | (setq cua--ena-region-keymap |
1068 | (and mark-active (not deactivate-mark))) | |
1069 | (setq cua--ena-prefix-override-keymap | |
1070 | (and cua--ena-region-keymap | |
1071 | cua-enable-cua-keys | |
63e6f5b3 | 1072 | (not cua-inhibit-cua-keys) |
72cc582e KS |
1073 | (or (eq cua-enable-cua-keys t) |
1074 | (not cua--explicit-region-start)) | |
1075 | (not executing-kbd-macro) | |
1076 | (not cua--prefix-override-timer))) | |
1077 | (setq cua--ena-prefix-repeat-keymap | |
1078 | (and cua--ena-region-keymap | |
1079 | (timerp cua--prefix-override-timer))) | |
1080 | (setq cua--ena-cua-keys-keymap | |
1081 | (and cua-enable-cua-keys | |
63e6f5b3 | 1082 | (not cua-inhibit-cua-keys) |
72cc582e KS |
1083 | (or (eq cua-enable-cua-keys t) |
1084 | cua--last-region-shifted))) | |
1085 | (setq cua--ena-global-mark-keymap | |
1086 | (and cua--global-mark-active | |
1087 | (not (window-minibuffer-p))))) | |
1088 | ||
1089 | (defvar cua--keymaps-initalized nil) | |
1090 | ||
1091 | (defun cua--init-keymaps () | |
1092 | (unless (eq cua-use-hyper-key 'only) | |
1093 | (define-key cua-global-keymap [(shift return)] 'cua-set-rectangle-mark)) | |
1094 | (when cua-use-hyper-key | |
1095 | (cua--M/H-key cua-global-keymap 'space 'cua-set-rectangle-mark) | |
1096 | (define-key cua-global-keymap [(hyper mouse-1)] 'cua-mouse-set-rectangle-mark)) | |
1097 | ||
1098 | (define-key cua-global-keymap [(shift control ? )] 'cua-toggle-global-mark) | |
1099 | ||
1100 | ;; replace region with rectangle or element on kill ring | |
1101 | (define-key cua-global-keymap [remap yank] 'cua-paste) | |
1102 | (define-key cua-global-keymap [remap clipboard-yank] 'cua-paste) | |
1103 | ;; replace current yank with previous kill ring element | |
1104 | (define-key cua-global-keymap [remap yank-pop] 'cua-paste-pop) | |
1105 | ;; set mark | |
1106 | (define-key cua-global-keymap [remap set-mark-command] 'cua-set-mark) | |
1107 | ;; undo | |
1108 | (define-key cua-global-keymap [remap undo] 'cua-undo) | |
1109 | (define-key cua-global-keymap [remap advertised-undo] 'cua-undo) | |
1110 | ||
1111 | (define-key cua--cua-keys-keymap [(control x) timeout] 'kill-region) | |
72cc582e | 1112 | (define-key cua--cua-keys-keymap [(control c) timeout] 'copy-region-as-kill) |
72cc582e KS |
1113 | (define-key cua--cua-keys-keymap [(control z)] 'undo) |
1114 | (define-key cua--cua-keys-keymap [(control v)] 'yank) | |
34a63289 | 1115 | (define-key cua--cua-keys-keymap [(meta v)] 'cua-repeat-replace-region) |
72cc582e KS |
1116 | (define-key cua--cua-keys-keymap [remap exchange-point-and-mark] 'cua-exchange-point-and-mark) |
1117 | ||
1118 | (define-key cua--prefix-override-keymap [(control x)] 'cua--prefix-override-handler) | |
1119 | (define-key cua--prefix-override-keymap [(control c)] 'cua--prefix-override-handler) | |
a1506d29 | 1120 | |
72cc582e KS |
1121 | (define-key cua--prefix-repeat-keymap [(control x) (control x)] 'cua--prefix-repeat-handler) |
1122 | (define-key cua--prefix-repeat-keymap [(control x) up] 'cua--prefix-cut-handler) | |
1123 | (define-key cua--prefix-repeat-keymap [(control x) down] 'cua--prefix-cut-handler) | |
1124 | (define-key cua--prefix-repeat-keymap [(control x) left] 'cua--prefix-cut-handler) | |
1125 | (define-key cua--prefix-repeat-keymap [(control x) right] 'cua--prefix-cut-handler) | |
1126 | (define-key cua--prefix-repeat-keymap [(control c) (control c)] 'cua--prefix-repeat-handler) | |
1127 | (define-key cua--prefix-repeat-keymap [(control c) up] 'cua--prefix-copy-handler) | |
1128 | (define-key cua--prefix-repeat-keymap [(control c) down] 'cua--prefix-copy-handler) | |
1129 | (define-key cua--prefix-repeat-keymap [(control c) left] 'cua--prefix-copy-handler) | |
1130 | (define-key cua--prefix-repeat-keymap [(control c) right] 'cua--prefix-copy-handler) | |
1131 | ||
a1506d29 | 1132 | ;; Enable shifted fallbacks for C-x and C-c when region is active |
d6f9ff15 KS |
1133 | (define-key cua--region-keymap [(shift control x)] 'Control-X-prefix) |
1134 | (define-key cua--region-keymap [(shift control c)] 'mode-specific-command-prefix) | |
72cc582e KS |
1135 | ;; replace current region |
1136 | (define-key cua--region-keymap [remap self-insert-command] 'cua-replace-region) | |
1137 | (define-key cua--region-keymap [remap self-insert-iso] 'cua-replace-region) | |
1138 | (define-key cua--region-keymap [remap insert-register] 'cua-replace-region) | |
1139 | (define-key cua--region-keymap [remap newline-and-indent] 'cua-replace-region) | |
1140 | (define-key cua--region-keymap [remap newline] 'cua-replace-region) | |
1141 | (define-key cua--region-keymap [remap open-line] 'cua-replace-region) | |
1142 | ;; delete current region | |
1143 | (define-key cua--region-keymap [remap delete-backward-char] 'cua-delete-region) | |
1144 | (define-key cua--region-keymap [remap backward-delete-char] 'cua-delete-region) | |
1145 | (define-key cua--region-keymap [remap backward-delete-char-untabify] 'cua-delete-region) | |
1146 | (define-key cua--region-keymap [remap delete-char] 'cua-delete-region) | |
1147 | ;; kill region | |
1148 | (define-key cua--region-keymap [remap kill-region] 'cua-cut-region) | |
1149 | ;; copy region | |
1150 | (define-key cua--region-keymap [remap copy-region-as-kill] 'cua-copy-region) | |
1151 | (define-key cua--region-keymap [remap kill-ring-save] 'cua-copy-region) | |
1152 | ;; cancel current region/rectangle | |
1153 | (define-key cua--region-keymap [remap keyboard-escape-quit] 'cua-cancel) | |
1154 | (define-key cua--region-keymap [remap keyboard-quit] 'cua-cancel) | |
1155 | ) | |
1156 | ||
cadc926b KS |
1157 | ;; State prior to enabling cua-mode |
1158 | ;; Value is a list with the following elements: | |
1159 | ;; transient-mark-mode | |
1160 | ;; delete-selection-mode | |
1161 | ;; pc-selection-mode | |
1162 | ||
1163 | (defvar cua--saved-state nil) | |
72cc582e KS |
1164 | |
1165 | ;;;###autoload | |
80d9508a | 1166 | (define-minor-mode cua-mode |
72cc582e KS |
1167 | "Toggle CUA key-binding mode. |
1168 | When enabled, using shifted movement keys will activate the region (and | |
1169 | highlight the region using `transient-mark-mode'), and typed text replaces | |
1170 | the active selection. C-z, C-x, C-c, and C-v will undo, cut, copy, and | |
1171 | paste (in addition to the normal emacs bindings)." | |
80d9508a SM |
1172 | :global t |
1173 | :set-after '(cua-enable-modeline-indications cua-use-hyper-key) | |
1174 | :require 'cua-base | |
1175 | :link '(emacs-commentary-link "cua-base.el") | |
1176 | :version "21.4" | |
72cc582e KS |
1177 | (setq mark-even-if-inactive t) |
1178 | (setq highlight-nonselected-windows nil) | |
1179 | (make-variable-buffer-local 'cua--explicit-region-start) | |
1180 | (make-variable-buffer-local 'cua--status-string) | |
1181 | ||
1182 | (unless cua--keymaps-initalized | |
1183 | (cua--init-keymaps) | |
1184 | (setq cua--keymaps-initalized t)) | |
1185 | ||
1186 | (if cua-mode | |
1187 | (progn | |
1188 | (add-hook 'pre-command-hook 'cua--pre-command-handler) | |
1189 | (add-hook 'post-command-hook 'cua--post-command-handler) | |
1190 | (if (and cua-enable-modeline-indications (not (assoc 'cua-mode minor-mode-alist))) | |
1191 | (setq minor-mode-alist (cons '(cua-mode cua--status-string) minor-mode-alist))) | |
1192 | ) | |
1193 | (remove-hook 'pre-command-hook 'cua--pre-command-handler) | |
1194 | (remove-hook 'post-command-hook 'cua--post-command-handler)) | |
a23a8440 KS |
1195 | |
1196 | (if (not cua-mode) | |
1197 | (setq emulation-mode-map-alists (delq 'cua--keymap-alist emulation-mode-map-alists)) | |
1198 | (add-to-list 'emulation-mode-map-alists 'cua--keymap-alist) | |
1199 | (cua--select-keymaps)) | |
1200 | ||
72cc582e KS |
1201 | (if (fboundp 'cua--rectangle-on-off) |
1202 | (cua--rectangle-on-off cua-mode)) | |
cadc926b KS |
1203 | |
1204 | (cond | |
1205 | (cua-mode | |
1206 | (setq cua--saved-state | |
1207 | (list | |
1208 | transient-mark-mode | |
1209 | (and (boundp 'delete-selection-mode) delete-selection-mode) | |
1210 | (and (boundp 'pc-selection-mode) pc-selection-mode))) | |
1211 | (if (and (boundp 'delete-selection-mode) delete-selection-mode) | |
d7672cf8 | 1212 | (delete-selection-mode -1)) |
cadc926b | 1213 | (if (and (boundp 'pc-selection-mode) pc-selection-mode) |
d7672cf8 | 1214 | (pc-selection-mode -1)) |
cadc926b KS |
1215 | (setq transient-mark-mode (and cua-mode |
1216 | (if cua-highlight-region-shift-only | |
1217 | (not cua--explicit-region-start) | |
80d9508a | 1218 | t)))) |
cadc926b KS |
1219 | (cua--saved-state |
1220 | (setq transient-mark-mode (car cua--saved-state)) | |
1221 | (if (nth 1 cua--saved-state) | |
1222 | (delete-selection-mode 1)) | |
1223 | (if (nth 2 cua--saved-state) | |
1224 | (pc-selection-mode 1)) | |
1225 | (if (interactive-p) | |
1226 | (message "CUA mode disabled.%s%s%s%s" | |
1227 | (if (nth 1 cua--saved-state) " Delete-Selection" "") | |
1228 | (if (and (nth 1 cua--saved-state) (nth 2 cua--saved-state)) " and" "") | |
1229 | (if (nth 2 cua--saved-state) " PC-Selection" "") | |
1230 | (if (or (nth 1 cua--saved-state) (nth 2 cua--saved-state)) " enabled" ""))) | |
80d9508a | 1231 | (setq cua--saved-state nil)))) |
72cc582e KS |
1232 | |
1233 | (defun cua-debug () | |
1234 | "Toggle cua debugging." | |
1235 | (interactive) | |
1236 | (setq cua--debug (not cua--debug))) | |
1237 | ||
06f8e605 KS |
1238 | ;; Install run-time check for older versions of CUA-mode which does not |
1239 | ;; work with GNU Emacs version 21.4 and newer. | |
1240 | ;; | |
1241 | ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode | |
1242 | ;; provided the `CUA-mode' feature. Since this is no longer true, | |
1243 | ;; we can warn the user if the `CUA-mode' feature is ever provided. | |
1244 | ||
1245 | ;;;###autoload (eval-after-load 'CUA-mode | |
1246 | ;;;###autoload '(error (concat "\n\n" | |
1247 | ;;;###autoload "CUA-mode is now part of the standard GNU Emacs distribution,\n" | |
1248 | ;;;###autoload "so you may now enable and customize CUA via the Options menu.\n\n" | |
1249 | ;;;###autoload "Your " (file-name-nondirectory user-init-file) " loads an older version of CUA-mode which does\n" | |
1250 | ;;;###autoload "not work correctly with this version of GNU Emacs.\n" | |
1251 | ;;;###autoload "To correct this, remove the loading and customization of the\n" | |
1252 | ;;;###autoload "old version from the " user-init-file " file.\n\n"))) | |
1253 | ||
f1cb14f8 KS |
1254 | (provide 'cua) |
1255 | ||
6b61353c | 1256 | ;;; arch-tag: 21fb6289-ba25-4fee-bfdc-f9fb351acf05 |
72cc582e | 1257 | ;;; cua-base.el ends here |