Commit | Line | Data |
---|---|---|
72cc582e KS |
1 | ;;; cua-base.el --- emulate CUA key bindings |
2 | ||
5fd6d89f | 3 | ;; Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, |
f0fa15c5 | 4 | ;; 2005, 2006, 2007 Free Software Foundation, Inc. |
72cc582e KS |
5 | |
6 | ;; Author: Kim F. Storm <storm@cua.dk> | |
7 | ;; Keywords: keyboard emulation convenience cua | |
8 | ||
9 | ;; This file is part of GNU Emacs. | |
10 | ||
11 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
12 | ;; it under the terms of the GNU General Public License as published by | |
e0085d62 | 13 | ;; the Free Software Foundation; either version 3, or (at your option) |
72cc582e KS |
14 | ;; any later version. |
15 | ||
16 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 | ;; GNU General Public License for more details. | |
20 | ||
21 | ;; You should have received a copy of the GNU General Public License | |
22 | ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
3a35cf56 LK |
23 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
24 | ;; Boston, MA 02110-1301, USA. | |
72cc582e KS |
25 | |
26 | ||
27 | ;;; Commentary: | |
28 | ||
29 | ;; This is the CUA package which provides a complete emulation of the | |
30 | ;; standard CUA key bindings (Motif/Windows/Mac GUI) for selecting and | |
31 | ;; manipulating the region where S-<movement> is used to highlight & | |
32 | ;; extend the region. | |
33 | ||
34a63289 KS |
34 | ;; CUA style key bindings for cut and paste |
35 | ;; ---------------------------------------- | |
36 | ||
37 | ;; This package allows the C-z, C-x, C-c, and C-v keys to be | |
72cc582e KS |
38 | ;; bound appropriately according to the Motif/Windows GUI, i.e. |
39 | ;; C-z -> undo | |
40 | ;; C-x -> cut | |
41 | ;; C-c -> copy | |
42 | ;; C-v -> paste | |
43 | ;; | |
44 | ;; The tricky part is the handling of the C-x and C-c keys which | |
45 | ;; are normally used as prefix keys for most of emacs' built-in | |
46 | ;; commands. With CUA they still do!!! | |
47 | ;; | |
48 | ;; Only when the region is currently active (and highlighted since | |
49 | ;; transient-mark-mode is used), the C-x and C-c keys will work as CUA | |
50 | ;; keys | |
51 | ;; C-x -> cut | |
52 | ;; C-c -> copy | |
53 | ;; When the region is not active, C-x and C-c works as prefix keys! | |
54 | ;; | |
55 | ;; This probably sounds strange and difficult to get used to - but | |
56 | ;; based on my own experience and the feedback from many users of | |
57 | ;; this package, it actually works very well and users adapt to it | |
a1506d29 | 58 | ;; instantly - or at least very quickly. So give it a try! |
72cc582e KS |
59 | ;; ... and in the few cases where you make a mistake and accidentally |
60 | ;; delete the region - you just undo the mistake (with C-z). | |
61 | ;; | |
62 | ;; If you really need to perform a command which starts with one of | |
63 | ;; the prefix keys even when the region is active, you have three options: | |
64 | ;; - press the prefix key twice very quickly (within 0.2 seconds), | |
1023b169 | 65 | ;; - press the prefix key and the following key within 0.2 seconds, or |
72cc582e KS |
66 | ;; - use the SHIFT key with the prefix key, i.e. C-X or C-C |
67 | ;; | |
68 | ;; This behaviour can be customized via the | |
69 | ;; cua-prefix-override-inhibit-delay variable. | |
70 | ||
71 | ;; In addition to using the shifted movement keys, you can also use | |
72 | ;; [C-space] to start the region and use unshifted movement keys to extend | |
73 | ;; it. To cancel the region, use [C-space] or [C-g]. | |
74 | ||
75 | ;; If you prefer to use the standard emacs cut, copy, paste, and undo | |
76 | ;; bindings, customize cua-enable-cua-keys to nil. | |
77 | ||
34a63289 KS |
78 | |
79 | ;; Typing text replaces the region | |
80 | ;; ------------------------------- | |
81 | ||
82 | ;; When the region is active, i.e. highlighted, the text in region is | |
83 | ;; replaced by the text you type. | |
84 | ||
85 | ;; The replaced text is saved in register 0 which can be inserted using | |
86 | ;; the key sequence M-0 C-v (see the section on register support below). | |
87 | ||
88 | ;; If you have just replaced a highlighted region with typed text, | |
89 | ;; you can repeat the replace with M-v. This will search forward | |
90 | ;; for a streach of text identical to the previous contents of the | |
91 | ;; region (i.e. the contents of register 0) and replace it with the | |
92 | ;; text you typed to replace the original region. Repeating M-v will | |
93 | ;; replace the next matching region and so on. | |
94 | ;; | |
95 | ;; Example: Suppose you have a line like this | |
96 | ;; The redo operation will redo the last redoable command | |
97 | ;; which you want to change into | |
98 | ;; The repeat operation will repeat the last repeatable command | |
99 | ;; This is done by highlighting the first occurrence of "redo" | |
100 | ;; and type "repeat" M-v M-v. | |
101 | ||
102 | ;; Note: Since CUA-mode duplicates the functionality of the | |
103 | ;; delete-selection-mode, that mode is automatically disabled when | |
104 | ;; CUA-mode is enabled. | |
105 | ||
106 | ||
72cc582e KS |
107 | ;; CUA mode indications |
108 | ;; -------------------- | |
109 | ;; You can choose to let CUA use different cursor colors to indicate | |
110 | ;; overwrite mode and read-only buffers. For example, the following | |
111 | ;; setting will use a RED cursor in normal (insertion) mode in | |
112 | ;; read-write buffers, a YELLOW cursor in overwrite mode in read-write | |
113 | ;; buffers, and a GREEN cursor read-only buffers: | |
114 | ;; | |
115 | ;; (setq cua-normal-cursor-color "red") | |
116 | ;; (setq cua-overwrite-cursor-color "yellow") | |
117 | ;; (setq cua-read-only-cursor-color "green") | |
118 | ;; | |
119 | ||
120 | ;; CUA register support | |
121 | ;; -------------------- | |
122 | ;; Emacs' standard register support is also based on a separate set of | |
123 | ;; "register commands". | |
a1506d29 | 124 | ;; |
72cc582e KS |
125 | ;; CUA's register support is activated by providing a numeric |
126 | ;; prefix argument to the C-x, C-c, and C-v commands. For example, | |
127 | ;; to copy the selected region to register 2, enter [M-2 C-c]. | |
128 | ;; Or if you have activated the keypad prefix mode, enter [kp-2 C-c]. | |
a1506d29 | 129 | ;; |
72cc582e KS |
130 | ;; And CUA will copy and paste normal region as well as rectangles |
131 | ;; into the registers, i.e. you use exactly the same command for both. | |
a1506d29 | 132 | ;; |
72cc582e KS |
133 | ;; In addition, the last highlighted text that is deleted (not |
134 | ;; copied), e.g. by [delete] or by typing text over a highlighted | |
135 | ;; region, is automatically saved in register 0, so you can insert it | |
136 | ;; using [M-0 C-v]. | |
137 | ||
138 | ;; CUA rectangle support | |
139 | ;; --------------------- | |
140 | ;; Emacs' normal rectangle support is based on interpreting the region | |
141 | ;; between the mark and point as a "virtual rectangle", and using a | |
142 | ;; completely separate set of "rectangle commands" [C-x r ...] on the | |
143 | ;; region to copy, kill, fill a.s.o. the virtual rectangle. | |
a1506d29 | 144 | ;; |
85d392cb KS |
145 | ;; cua-mode's superior rectangle support uses a true visual |
146 | ;; representation of the selected rectangle, i.e. it highlights the | |
147 | ;; actual part of the buffer that is currently selected as part of the | |
148 | ;; rectangle. Unlike emacs' traditional rectangle commands, the | |
149 | ;; selected rectangle always as straight left and right edges, even | |
150 | ;; when those are in the middle of a TAB character or beyond the end | |
151 | ;; of the current line. And it does this without actually modifying | |
152 | ;; the buffer contents (it uses display overlays to visualize the | |
153 | ;; virtual dimensions of the rectangle). | |
154 | ;; | |
155 | ;; This means that cua-mode's rectangles are not limited to the actual | |
156 | ;; contents of the buffer, so if the cursor is currently at the end of a | |
157 | ;; short line, you can still extend the rectangle to include more columns | |
158 | ;; of longer lines in the same rectangle. And you can also have the | |
159 | ;; left edge of a rectangle start in the middle of a TAB character. | |
160 | ;; Sounds strange? Try it! | |
161 | ;; | |
c9ee062d | 162 | ;; To start a rectangle, use [C-return] and extend it using the normal |
85d392cb KS |
163 | ;; movement keys (up, down, left, right, home, end, C-home, |
164 | ;; C-end). Once the rectangle has the desired size, you can cut or | |
165 | ;; copy it using C-x and C-c (or C-w and M-w), and you can | |
166 | ;; subsequently insert it - as a rectangle - using C-v (or C-y). So | |
167 | ;; the only new command you need to know to work with cua-mode | |
c9ee062d | 168 | ;; rectangles is C-return! |
72cc582e KS |
169 | ;; |
170 | ;; Normally, when you paste a rectangle using C-v (C-y), each line of | |
171 | ;; the rectangle is inserted into the existing lines in the buffer. | |
172 | ;; If overwrite-mode is active when you paste a rectangle, it is | |
173 | ;; inserted as normal (multi-line) text. | |
a1506d29 | 174 | ;; |
85d392cb KS |
175 | ;; If you prefer the traditional rectangle marking (i.e. don't want |
176 | ;; straight edges), [M-p] toggles this for the current rectangle, | |
177 | ;; or you can customize cua-virtual-rectangle-edges. | |
72cc582e KS |
178 | |
179 | ;; And there's more: If you want to extend or reduce the size of the | |
180 | ;; rectangle in one of the other corners of the rectangle, just use | |
181 | ;; [return] to move the cursor to the "next" corner. Or you can use | |
182 | ;; the [M-up], [M-down], [M-left], and [M-right] keys to move the | |
183 | ;; entire rectangle overlay (but not the contents) in the given | |
184 | ;; direction. | |
185 | ;; | |
c9ee062d | 186 | ;; [C-return] cancels the rectangle |
72cc582e KS |
187 | ;; [C-space] activates the region bounded by the rectangle |
188 | ||
189 | ;; If you type a normal (self-inserting) character when the rectangle is | |
190 | ;; active, the character is inserted on the "current side" of every line | |
191 | ;; of the rectangle. The "current side" is the side on which the cursor | |
192 | ;; is currently located. If the rectangle is only 1 column wide, | |
193 | ;; insertion will be performed to the left when the cursor is at the | |
194 | ;; bottom of the rectangle. So, for example, to comment out an entire | |
195 | ;; paragraph like this one, just place the cursor on the first character | |
196 | ;; of the first line, and enter the following: | |
c9ee062d | 197 | ;; C-return M-} ; ; <space> C-return |
a1506d29 | 198 | |
72cc582e KS |
199 | ;; cua-mode's rectangle support also includes all the normal rectangle |
200 | ;; functions with easy access: | |
201 | ;; | |
202 | ;; [M-a] aligns all words at the left edge of the rectangle | |
203 | ;; [M-b] fills the rectangle with blanks (tabs and spaces) | |
204 | ;; [M-c] closes the rectangle by removing all blanks at the left edge | |
205 | ;; of the rectangle | |
206 | ;; [M-f] fills the rectangle with a single character (prompt) | |
207 | ;; [M-i] increases the first number found on each line of the rectangle | |
208 | ;; by the amount given by the numeric prefix argument (default 1) | |
209 | ;; It recognizes 0x... as hexadecimal numbers | |
210 | ;; [M-k] kills the rectangle as normal multi-line text (for paste) | |
211 | ;; [M-l] downcases the rectangle | |
212 | ;; [M-m] copies the rectangle as normal multi-line text (for paste) | |
213 | ;; [M-n] fills each line of the rectangle with increasing numbers using | |
214 | ;; a supplied format string (prompt) | |
a1506d29 | 215 | ;; [M-o] opens the rectangle by moving the highlighted text to the |
72cc582e | 216 | ;; right of the rectangle and filling the rectangle with blanks. |
85d392cb KS |
217 | ;; [M-p] toggles virtual straight rectangle edges |
218 | ;; [M-P] inserts tabs and spaces (padding) to make real straight edges | |
72cc582e KS |
219 | ;; [M-q] performs text filling on the rectangle |
220 | ;; [M-r] replaces REGEXP (prompt) by STRING (prompt) in rectangle | |
221 | ;; [M-R] reverse the lines in the rectangle | |
222 | ;; [M-s] fills each line of the rectangle with the same STRING (prompt) | |
223 | ;; [M-t] performs text fill of the rectangle with TEXT (prompt) | |
224 | ;; [M-u] upcases the rectangle | |
225 | ;; [M-|] runs shell command on rectangle | |
226 | ;; [M-'] restricts rectangle to lines with CHAR (prompt) at left column | |
227 | ;; [M-/] restricts rectangle to lines matching REGEXP (prompt) | |
228 | ;; [C-?] Shows a brief list of the above commands. | |
229 | ||
230 | ;; [M-C-up] and [M-C-down] scrolls the lines INSIDE the rectangle up | |
231 | ;; and down; lines scrolled outside the top or bottom of the rectangle | |
232 | ;; are lost, but can be recovered using [C-z]. | |
233 | ||
234 | ;; CUA Global Mark | |
a1506d29 | 235 | ;; --------------- |
72cc582e KS |
236 | ;; The final feature provided by CUA is the "global mark", which |
237 | ;; makes it very easy to copy bits and pieces from the same and other | |
238 | ;; files into the current text. To enable and cancel the global mark, | |
239 | ;; use [S-C-space]. The cursor will blink when the global mark | |
240 | ;; is active. The following commands behave differently when the global | |
241 | ;; mark is set: | |
a1506d29 | 242 | ;; <ch> All characters (including newlines) you type are inserted |
72cc582e KS |
243 | ;; at the global mark! |
244 | ;; [C-x] If you cut a region or rectangle, it is automatically inserted | |
245 | ;; at the global mark, and the global mark is advanced. | |
246 | ;; [C-c] If you copy a region or rectangle, it is immediately inserted | |
247 | ;; at the global mark, and the global mark is advanced. | |
248 | ;; [C-v] Copies a single character to the global mark. | |
249 | ;; [C-d] Moves (i.e. deletes and inserts) a single character to the | |
250 | ;; global mark. | |
251 | ;; [backspace] deletes the character before the global mark, while | |
252 | ;; [delete] deltes the character after the global mark. | |
253 | ||
254 | ;; [S-C-space] Jumps to and cancels the global mark. | |
255 | ;; [C-u S-C-space] Cancels the global mark (stays in current buffer). | |
256 | ||
257 | ;; [TAB] Indents the current line or rectangle to the column of the | |
258 | ;; global mark. | |
259 | ||
260 | ;;; Code: | |
261 | ||
262 | ;;; Customization | |
263 | ||
264 | (defgroup cua nil | |
265 | "Emulate CUA key bindings including C-x and C-c." | |
266 | :prefix "cua" | |
267 | :group 'editing-basics | |
268 | :group 'convenience | |
269 | :group 'emulations | |
bf247b6e | 270 | :version "22.1" |
72cc582e KS |
271 | :link '(emacs-commentary-link :tag "Commentary" "cua-base.el") |
272 | :link '(emacs-library-link :tag "Lisp File" "cua-base.el")) | |
273 | ||
72cc582e KS |
274 | (defcustom cua-enable-cua-keys t |
275 | "*Enable using C-z, C-x, C-c, and C-v for undo, cut, copy, and paste. | |
276 | If the value is t, these mappings are always enabled. If the value is | |
1023b169 | 277 | `shift', these keys are only enabled if the last region was marked with |
72cc582e KS |
278 | a shifted movement key. If the value is nil, these keys are never |
279 | enabled." | |
a1506d29 | 280 | :type '(choice (const :tag "Disabled" nil) |
72cc582e | 281 | (const :tag "Shift region only" shift) |
c1cdea1a | 282 | (other :tag "Enabled" t)) |
72cc582e KS |
283 | :group 'cua) |
284 | ||
285 | (defcustom cua-highlight-region-shift-only nil | |
286 | "*If non-nil, only highlight region if marked with S-<move>. | |
287 | When this is non-nil, CUA toggles `transient-mark-mode' on when the region | |
288 | is marked using shifted movement keys, and off when the mark is cleared. | |
289 | But when the mark was set using \\[cua-set-mark], transient-mark-mode | |
290 | is not turned on." | |
291 | :type 'boolean | |
292 | :group 'cua) | |
293 | ||
a1506d29 | 294 | (defcustom cua-prefix-override-inhibit-delay |
72cc582e KS |
295 | (if (featurep 'lisp-float-type) (/ (float 1) (float 5)) nil) |
296 | "*If non-nil, time in seconds to delay before overriding prefix key. | |
297 | If there is additional input within this time, the prefix key is | |
298 | used as a normal prefix key. So typing a key sequence quickly will | |
299 | inhibit overriding the prefix key. | |
300 | As a special case, if the prefix keys repeated within this time, the | |
301 | first prefix key is discarded, so typing a prefix key twice in quick | |
302 | succession will also inhibit overriding the prefix key. | |
303 | If the value is nil, use a shifted prefix key to inhibit the override." | |
304 | :type '(choice (number :tag "Inhibit delay") | |
305 | (const :tag "No delay" nil)) | |
306 | :group 'cua) | |
307 | ||
ae6ffe99 KS |
308 | (defcustom cua-delete-selection t |
309 | "*If non-nil, typed text replaces text in the active selection." | |
310 | :type '(choice (const :tag "Disabled" nil) | |
311 | (other :tag "Enabled" t)) | |
312 | :group 'cua) | |
313 | ||
72cc582e KS |
314 | (defcustom cua-keep-region-after-copy nil |
315 | "If non-nil, don't deselect the region after copying." | |
316 | :type 'boolean | |
317 | :group 'cua) | |
318 | ||
ae6ffe99 | 319 | (defcustom cua-toggle-set-mark t |
c64a6023 | 320 | "*If non-nil, the `cua-set-mark' command toggles the mark." |
ae6ffe99 KS |
321 | :type '(choice (const :tag "Disabled" nil) |
322 | (other :tag "Enabled" t)) | |
323 | :group 'cua) | |
324 | ||
c64a6023 KS |
325 | (defcustom cua-auto-mark-last-change nil |
326 | "*If non-nil, set implicit mark at position of last buffer change. | |
327 | This means that \\[universal-argument] \\[cua-set-mark] will jump to the position | |
328 | of the last buffer change before jumping to the explicit marks on the mark ring. | |
329 | See `cua-set-mark' for details." | |
330 | :type 'boolean | |
331 | :group 'cua) | |
332 | ||
72cc582e KS |
333 | (defcustom cua-enable-register-prefix 'not-ctrl-u |
334 | "*If non-nil, registers are supported via numeric prefix arg. | |
335 | If the value is t, any numeric prefix arg in the range 0 to 9 will be | |
a1506d29 | 336 | interpreted as a register number. |
1023b169 | 337 | If the value is `not-ctrl-u', using C-u to enter a numeric prefix is not |
a1506d29 | 338 | interpreted as a register number. |
1023b169 | 339 | If the value is `ctrl-u-only', only numeric prefix entered with C-u is |
72cc582e | 340 | interpreted as a register number." |
a1506d29 | 341 | :type '(choice (const :tag "Disabled" nil) |
72cc582e KS |
342 | (const :tag "Enabled, but C-u arg is not a register" not-ctrl-u) |
343 | (const :tag "Enabled, but only for C-u arg" ctrl-u-only) | |
c1cdea1a | 344 | (other :tag "Enabled" t)) |
72cc582e KS |
345 | :group 'cua) |
346 | ||
347 | (defcustom cua-delete-copy-to-register-0 t | |
348 | "*If non-nil, save last deleted region or rectangle to register 0." | |
349 | :type 'boolean | |
350 | :group 'cua) | |
351 | ||
72cc582e KS |
352 | (defcustom cua-enable-region-auto-help nil |
353 | "*If non-nil, automatically show help for active region." | |
354 | :type 'boolean | |
355 | :group 'cua) | |
356 | ||
357 | (defcustom cua-enable-modeline-indications nil | |
358 | "*If non-nil, use minor-mode hook to show status in mode line." | |
359 | :type 'boolean | |
360 | :group 'cua) | |
361 | ||
362 | (defcustom cua-check-pending-input t | |
363 | "*If non-nil, don't override prefix key if input pending. | |
c77d7c92 | 364 | It is rumoured that `input-pending-p' is unreliable under some window |
72cc582e KS |
365 | managers, so try setting this to nil, if prefix override doesn't work." |
366 | :type 'boolean | |
367 | :group 'cua) | |
368 | ||
c64a6023 KS |
369 | (defcustom cua-paste-pop-rotate-temporarily nil |
370 | "*If non-nil, \\[cua-paste-pop] only rotates the kill-ring temporarily. | |
fc363578 KS |
371 | This means that both \\[yank] and the first \\[yank-pop] in a sequence always insert |
372 | the most recently killed text. Each immediately following \\[cua-paste-pop] replaces | |
373 | the previous text with the next older element on the `kill-ring'. | |
374 | With prefix arg, \\[universal-argument] \\[yank-pop] inserts the same text as the most | |
375 | recent \\[yank-pop] (or \\[yank]) command." | |
c64a6023 KS |
376 | :type 'boolean |
377 | :group 'cua) | |
72cc582e KS |
378 | |
379 | ;;; Rectangle Customization | |
380 | ||
85d392cb KS |
381 | (defcustom cua-virtual-rectangle-edges t |
382 | "*If non-nil, rectangles have virtual straight edges. | |
383 | Note that although rectangles are always DISPLAYED with straight edges, the | |
384 | buffer is NOT modified, until you execute a command that actually modifies it. | |
1023b169 | 385 | M-p toggles this feature when a rectangle is active." |
72cc582e KS |
386 | :type 'boolean |
387 | :group 'cua) | |
388 | ||
85d392cb KS |
389 | (defcustom cua-auto-tabify-rectangles 1000 |
390 | "*If non-nil, automatically tabify after rectangle commands. | |
391 | This basically means that `tabify' is applied to all lines that | |
392 | are modified by inserting or deleting a rectangle. If value is | |
c77d7c92 | 393 | an integer, CUA will look for existing tabs in a region around |
85d392cb KS |
394 | the rectangle, and only do the conversion if any tabs are already |
395 | present. The number specifies then number of characters before | |
396 | and after the region marked by the rectangle to search." | |
397 | :type '(choice (number :tag "Auto detect (limit)") | |
398 | (const :tag "Disabled" nil) | |
399 | (other :tag "Enabled" t)) | |
400 | :group 'cua) | |
401 | ||
5c4a6052 KS |
402 | (defvar cua-global-keymap) ; forward |
403 | (defvar cua--region-keymap) ; forward | |
404 | ||
1cb225da KS |
405 | (defcustom cua-rectangle-mark-key [(control return)] |
406 | "Global key used to toggle the cua rectangle mark." | |
407 | :set #'(lambda (symbol value) | |
408 | (set symbol value) | |
409 | (when (and (boundp 'cua--keymaps-initalized) | |
410 | cua--keymaps-initalized) | |
411 | (define-key cua-global-keymap value | |
412 | 'cua-set-rectangle-mark) | |
413 | (when (boundp 'cua--rectangle-keymap) | |
414 | (define-key cua--rectangle-keymap value | |
415 | 'cua-clear-rectangle-mark) | |
416 | (define-key cua--region-keymap value | |
417 | 'cua-toggle-rectangle-mark)))) | |
418 | :type 'key-sequence | |
419 | :group 'cua) | |
420 | ||
1638bf54 KS |
421 | (defcustom cua-rectangle-modifier-key 'meta |
422 | "*Modifier key used for rectangle commands bindings. | |
423 | On non-window systems, always use the meta modifier. | |
424 | Must be set prior to enabling CUA." | |
425 | :type '(choice (const :tag "Meta key" meta) | |
ae6ffe99 KS |
426 | (const :tag "Alt key" alt) |
427 | (const :tag "Hyper key" hyper) | |
1638bf54 KS |
428 | (const :tag "Super key" super)) |
429 | :group 'cua) | |
430 | ||
72cc582e KS |
431 | (defcustom cua-enable-rectangle-auto-help t |
432 | "*If non-nil, automatically show help for region, rectangle and global mark." | |
433 | :type 'boolean | |
434 | :group 'cua) | |
435 | ||
1e98d199 | 436 | (defface cua-rectangle |
03622614 KS |
437 | '((default :inherit region) |
438 | (((class color)) :foreground "white" :background "maroon")) | |
72cc582e KS |
439 | "*Font used by CUA for highlighting the rectangle." |
440 | :group 'cua) | |
441 | ||
1e98d199 | 442 | (defface cua-rectangle-noselect |
03622614 KS |
443 | '((default :inherit region) |
444 | (((class color)) :foreground "white" :background "dimgray")) | |
72cc582e KS |
445 | "*Font used by CUA for highlighting the non-selected rectangle lines." |
446 | :group 'cua) | |
447 | ||
72cc582e KS |
448 | |
449 | ;;; Global Mark Customization | |
450 | ||
451 | (defcustom cua-global-mark-keep-visible t | |
452 | "*If non-nil, always keep global mark visible in other window." | |
453 | :type 'boolean | |
454 | :group 'cua) | |
455 | ||
1e98d199 | 456 | (defface cua-global-mark |
fbcaad36 DN |
457 | '((((min-colors 88)(class color)) :foreground "black" :background "yellow1") |
458 | (((class color)) :foreground "black" :background "yellow") | |
03622614 | 459 | (t :bold t)) |
72cc582e KS |
460 | "*Font used by CUA for highlighting the global mark." |
461 | :group 'cua) | |
462 | ||
463 | (defcustom cua-global-mark-blink-cursor-interval 0.20 | |
464 | "*Blink cursor at this interval when global mark is active." | |
465 | :type '(choice (number :tag "Blink interval") | |
466 | (const :tag "No blink" nil)) | |
467 | :group 'cua) | |
468 | ||
469 | ||
470 | ;;; Cursor Indication Customization | |
471 | ||
cadc926b | 472 | (defcustom cua-enable-cursor-indications nil |
72cc582e KS |
473 | "*If non-nil, use different cursor colors for indications." |
474 | :type 'boolean | |
475 | :group 'cua) | |
476 | ||
496c17d6 KS |
477 | (defcustom cua-normal-cursor-color (or (and (boundp 'initial-cursor-color) initial-cursor-color) |
478 | (and (boundp 'initial-frame-alist) | |
479 | (assoc 'cursor-color initial-frame-alist) | |
480 | (cdr (assoc 'cursor-color initial-frame-alist))) | |
481 | (and (boundp 'default-frame-alist) | |
482 | (assoc 'cursor-color default-frame-alist) | |
483 | (cdr (assoc 'cursor-color default-frame-alist))) | |
484 | (frame-parameter nil 'cursor-color) | |
485 | "red") | |
72cc582e | 486 | "Normal (non-overwrite) cursor color. |
2ed2415d KS |
487 | Default is to load cursor color from initial or default frame parameters. |
488 | ||
489 | If the value is a COLOR name, then only the `cursor-color' attribute will be | |
b1227a16 | 490 | affected. If the value is a cursor TYPE (one of: box, hollow, bar, or hbar), |
2ed2415d KS |
491 | then only the `cursor-type' property will be affected. If the value is |
492 | a cons (TYPE . COLOR), then both properties are affected." | |
496c17d6 | 493 | :initialize 'custom-initialize-default |
2ed2415d KS |
494 | :type '(choice |
495 | (color :tag "Color") | |
496 | (choice :tag "Type" | |
497 | (const :tag "Filled box" box) | |
498 | (const :tag "Vertical bar" bar) | |
63baed99 | 499 | (const :tag "Horizontal bar" hbar) |
b1227a16 | 500 | (const :tag "Hollow box" hollow)) |
2ed2415d KS |
501 | (cons :tag "Color and Type" |
502 | (choice :tag "Type" | |
503 | (const :tag "Filled box" box) | |
504 | (const :tag "Vertical bar" bar) | |
63baed99 | 505 | (const :tag "Horizontal bar" hbar) |
b1227a16 | 506 | (const :tag "Hollow box" hollow)) |
2ed2415d | 507 | (color :tag "Color"))) |
72cc582e KS |
508 | :group 'cua) |
509 | ||
510 | (defcustom cua-read-only-cursor-color "darkgreen" | |
3ffc8a8a | 511 | "*Cursor color used in read-only buffers, if non-nil. |
2ed2415d KS |
512 | Only used when `cua-enable-cursor-indications' is non-nil. |
513 | ||
514 | If the value is a COLOR name, then only the `cursor-color' attribute will be | |
b1227a16 | 515 | affected. If the value is a cursor TYPE (one of: box, hollow, bar, or hbar), |
2ed2415d KS |
516 | then only the `cursor-type' property will be affected. If the value is |
517 | a cons (TYPE . COLOR), then both properties are affected." | |
518 | :type '(choice | |
519 | (color :tag "Color") | |
520 | (choice :tag "Type" | |
521 | (const :tag "Filled box" box) | |
522 | (const :tag "Vertical bar" bar) | |
63baed99 | 523 | (const :tag "Horizontal bar" hbar) |
b1227a16 | 524 | (const :tag "Hollow box" hollow)) |
2ed2415d KS |
525 | (cons :tag "Color and Type" |
526 | (choice :tag "Type" | |
527 | (const :tag "Filled box" box) | |
528 | (const :tag "Vertical bar" bar) | |
63baed99 | 529 | (const :tag "Horizontal bar" hbar) |
b1227a16 | 530 | (const :tag "Hollow box" hollow)) |
2ed2415d | 531 | (color :tag "Color"))) |
72cc582e KS |
532 | :group 'cua) |
533 | ||
534 | (defcustom cua-overwrite-cursor-color "yellow" | |
535 | "*Cursor color used when overwrite mode is set, if non-nil. | |
2ed2415d KS |
536 | Only used when `cua-enable-cursor-indications' is non-nil. |
537 | ||
538 | If the value is a COLOR name, then only the `cursor-color' attribute will be | |
b1227a16 | 539 | affected. If the value is a cursor TYPE (one of: box, hollow, bar, or hbar), |
2ed2415d KS |
540 | then only the `cursor-type' property will be affected. If the value is |
541 | a cons (TYPE . COLOR), then both properties are affected." | |
542 | :type '(choice | |
543 | (color :tag "Color") | |
544 | (choice :tag "Type" | |
545 | (const :tag "Filled box" box) | |
546 | (const :tag "Vertical bar" bar) | |
63baed99 | 547 | (const :tag "Horizontal bar" hbar) |
b1227a16 | 548 | (const :tag "Hollow box" hollow)) |
2ed2415d KS |
549 | (cons :tag "Color and Type" |
550 | (choice :tag "Type" | |
551 | (const :tag "Filled box" box) | |
552 | (const :tag "Vertical bar" bar) | |
63baed99 | 553 | (const :tag "Horizontal bar" hbar) |
b1227a16 | 554 | (const :tag "Hollow box" hollow)) |
2ed2415d | 555 | (color :tag "Color"))) |
72cc582e KS |
556 | :group 'cua) |
557 | ||
558 | (defcustom cua-global-mark-cursor-color "cyan" | |
559 | "*Indication for active global mark. | |
3ffc8a8a | 560 | Will change cursor color to specified color if string. |
2ed2415d KS |
561 | Only used when `cua-enable-cursor-indications' is non-nil. |
562 | ||
563 | If the value is a COLOR name, then only the `cursor-color' attribute will be | |
b1227a16 | 564 | affected. If the value is a cursor TYPE (one of: box, hollow, bar, or hbar), |
2ed2415d KS |
565 | then only the `cursor-type' property will be affected. If the value is |
566 | a cons (TYPE . COLOR), then both properties are affected." | |
567 | :type '(choice | |
568 | (color :tag "Color") | |
569 | (choice :tag "Type" | |
570 | (const :tag "Filled box" box) | |
571 | (const :tag "Vertical bar" bar) | |
63baed99 | 572 | (const :tag "Horizontal bar" hbar) |
b1227a16 | 573 | (const :tag "Hollow box" hollow)) |
2ed2415d KS |
574 | (cons :tag "Color and Type" |
575 | (choice :tag "Type" | |
576 | (const :tag "Filled box" box) | |
577 | (const :tag "Vertical bar" bar) | |
63baed99 | 578 | (const :tag "Horizontal bar" hbar) |
b1227a16 | 579 | (const :tag "Hollow box" hollow)) |
2ed2415d | 580 | (color :tag "Color"))) |
72cc582e KS |
581 | :group 'cua) |
582 | ||
583 | ||
584 | ;;; Rectangle support is in cua-rect.el | |
585 | ||
586 | (autoload 'cua-set-rectangle-mark "cua-rect" nil t nil) | |
587 | ||
588 | ;; Stub definitions until it is loaded | |
589 | ||
590 | (when (not (featurep 'cua-rect)) | |
591 | (defvar cua--rectangle) | |
592 | (setq cua--rectangle nil) | |
593 | (defvar cua--last-killed-rectangle) | |
594 | (setq cua--last-killed-rectangle nil)) | |
595 | ||
596 | ||
597 | ||
598 | ;;; Global Mark support is in cua-gmrk.el | |
599 | ||
4fe3f297 | 600 | (autoload 'cua-toggle-global-mark "cua-gmrk" nil t nil) |
72cc582e KS |
601 | |
602 | ;; Stub definitions until cua-gmrk.el is loaded | |
603 | ||
604 | (when (not (featurep 'cua-gmrk)) | |
605 | (defvar cua--global-mark-active) | |
606 | (setq cua--global-mark-active nil)) | |
607 | ||
608 | ||
609 | (provide 'cua-base) | |
610 | ||
611 | (eval-when-compile | |
612 | (require 'cua-rect) | |
613 | (require 'cua-gmrk) | |
614 | ) | |
615 | ||
63e6f5b3 KS |
616 | |
617 | ;;; Low-level Interface | |
618 | ||
619 | (defvar cua-inhibit-cua-keys nil | |
c77d7c92 | 620 | "Buffer-local variable that may disable the CUA keymappings.") |
63e6f5b3 KS |
621 | (make-variable-buffer-local 'cua-inhibit-cua-keys) |
622 | ||
72cc582e KS |
623 | ;;; Aux. variables |
624 | ||
625 | ;; Current region was started using cua-set-mark. | |
626 | (defvar cua--explicit-region-start nil) | |
ecd61067 | 627 | (make-variable-buffer-local 'cua--explicit-region-start) |
72cc582e KS |
628 | |
629 | ;; Latest region was started using shifted movement command. | |
630 | (defvar cua--last-region-shifted nil) | |
631 | ||
632 | ;; buffer + point prior to current command when rectangle is active | |
633 | ;; checked in post-command hook to see if point was moved | |
634 | (defvar cua--buffer-and-point-before-command nil) | |
635 | ||
636 | ;; status string for mode line indications | |
637 | (defvar cua--status-string nil) | |
ecd61067 | 638 | (make-variable-buffer-local 'cua--status-string) |
72cc582e KS |
639 | |
640 | (defvar cua--debug nil) | |
641 | ||
642 | ||
643 | ;;; Prefix key override mechanism | |
644 | ||
645 | ;; The prefix override (when mark-active) operates in three substates: | |
646 | ;; [1] Before using a prefix key | |
647 | ;; [2] Immediately after using a prefix key | |
648 | ;; [3] A fraction of a second later | |
649 | ||
650 | ;; In state [1], the cua--prefix-override-keymap is active. | |
651 | ;; This keymap binds the C-x and C-c prefix keys to the | |
652 | ;; cua--prefix-override-handler function. | |
653 | ||
654 | ;; When a prefix key is typed in state [1], cua--prefix-override-handler | |
655 | ;; will push back the keys already read to the event queue. If input is | |
656 | ;; pending, it changes directly to state [3]. Otherwise, a short timer [T] | |
657 | ;; is started, and it changes to state [2]. | |
658 | ||
659 | ;; In state [2], the cua--prefix-override-keymap is inactive. Instead the | |
660 | ;; cua--prefix-repeat-keymap is active. This keymap binds C-c C-c and C-x | |
661 | ;; C-x to the cua--prefix-repeat-handler function. | |
662 | ||
663 | ;; If the prefix key is repeated in state [2], cua--prefix-repeat-handler | |
664 | ;; will cancel [T], back the keys already read (except for the second prefix | |
665 | ;; keys) to the event queue, and changes to state [3]. | |
666 | ||
667 | ;; The basic cua--cua-keys-keymap binds [C-x timeout] to kill-region and | |
668 | ;; [C-c timeout] to copy-region-as-kill, so if [T] times out in state [2], | |
669 | ;; the cua--prefix-override-timeout function will push a `timeout' event on | |
670 | ;; the event queue, and changes to state [3]. | |
671 | ||
672 | ;; In state [3] both cua--prefix-override-keymap and cua--prefix-repeat-keymap | |
673 | ;; are inactive, so the timeout in cua-global-keymap binding is used, or the | |
674 | ;; normal prefix key binding from the global or local map will be used. | |
675 | ||
676 | ;; The pre-command hook (executed as a consequence of the timeout or normal | |
677 | ;; prefix key binding) will cancel [T] and change from state [3] back to | |
678 | ;; state [1]. So cua--prefix-override-handler and cua--prefix-repeat-handler | |
679 | ;; are always called with state reset to [1]! | |
680 | ||
681 | ;; State [1] is recognized by cua--prefix-override-timer is nil, | |
682 | ;; state [2] is recognized by cua--prefix-override-timer is a timer, and | |
683 | ;; state [3] is recognized by cua--prefix-override-timer is t. | |
684 | ||
685 | (defvar cua--prefix-override-timer nil) | |
686 | (defvar cua--prefix-override-length nil) | |
687 | ||
688 | (defun cua--prefix-override-replay (arg repeat) | |
689 | (let* ((keys (this-command-keys)) | |
690 | (i (length keys)) | |
691 | (key (aref keys (1- i)))) | |
692 | (setq cua--prefix-override-length (- i repeat)) | |
693 | (setq cua--prefix-override-timer | |
694 | (or | |
695 | ;; In state [2], change to state [3] | |
696 | (> repeat 0) | |
697 | ;; In state [1], change directly to state [3] | |
698 | (and cua-check-pending-input (input-pending-p)) | |
699 | ;; In state [1], [T] disabled, so change to state [3] | |
700 | (not (numberp cua-prefix-override-inhibit-delay)) | |
701 | (<= cua-prefix-override-inhibit-delay 0) | |
702 | ;; In state [1], start [T] and change to state [2] | |
a1506d29 | 703 | (run-with-timer cua-prefix-override-inhibit-delay nil |
72cc582e KS |
704 | 'cua--prefix-override-timeout))) |
705 | ;; Don't record this command | |
706 | (setq this-command last-command) | |
707 | ;; Restore the prefix arg | |
708 | (setq prefix-arg arg) | |
709 | (reset-this-command-lengths) | |
710 | ;; Push the key back on the event queue | |
711 | (setq unread-command-events (cons key unread-command-events)))) | |
712 | ||
713 | (defun cua--prefix-override-handler (arg) | |
714 | "Start timer waiting for prefix key to be followed by another key. | |
715 | Repeating prefix key when region is active works as a single prefix key." | |
716 | (interactive "P") | |
717 | (cua--prefix-override-replay arg 0)) | |
718 | ||
719 | (defun cua--prefix-repeat-handler (arg) | |
720 | "Repeating prefix key when region is active works as a single prefix key." | |
721 | (interactive "P") | |
722 | (cua--prefix-override-replay arg 1)) | |
723 | ||
724 | (defun cua--prefix-copy-handler (arg) | |
725 | "Copy region/rectangle, then replay last key." | |
726 | (interactive "P") | |
727 | (if cua--rectangle | |
728 | (cua-copy-rectangle arg) | |
729 | (cua-copy-region arg)) | |
730 | (let ((keys (this-single-command-keys))) | |
a1506d29 | 731 | (setq unread-command-events |
72cc582e KS |
732 | (cons (aref keys (1- (length keys))) unread-command-events)))) |
733 | ||
734 | (defun cua--prefix-cut-handler (arg) | |
735 | "Cut region/rectangle, then replay last key." | |
736 | (interactive "P") | |
737 | (if cua--rectangle | |
738 | (cua-cut-rectangle arg) | |
739 | (cua-cut-region arg)) | |
740 | (let ((keys (this-single-command-keys))) | |
a1506d29 | 741 | (setq unread-command-events |
72cc582e KS |
742 | (cons (aref keys (1- (length keys))) unread-command-events)))) |
743 | ||
744 | (defun cua--prefix-override-timeout () | |
745 | (setq cua--prefix-override-timer t) | |
746 | (when (= (length (this-command-keys)) cua--prefix-override-length) | |
747 | (setq unread-command-events (cons 'timeout unread-command-events)) | |
748 | (if prefix-arg | |
749 | (reset-this-command-lengths) | |
750 | (setq overriding-terminal-local-map nil)) | |
a23a8440 | 751 | (cua--select-keymaps))) |
72cc582e KS |
752 | |
753 | ||
754 | ;;; Aux. functions | |
755 | ||
756 | (defun cua--fallback () | |
757 | ;; Execute original command | |
758 | (setq this-command this-original-command) | |
759 | (call-interactively this-command)) | |
a1506d29 | 760 | |
72cc582e KS |
761 | (defun cua--keep-active () |
762 | (setq mark-active t | |
763 | deactivate-mark nil)) | |
764 | ||
765 | (defun cua--deactivate (&optional now) | |
766 | (setq cua--explicit-region-start nil) | |
767 | (if (not now) | |
768 | (setq deactivate-mark t) | |
769 | (setq mark-active nil) | |
770 | (run-hooks 'deactivate-mark-hook))) | |
771 | ||
772 | ||
773 | ;; The current register prefix | |
774 | (defvar cua--register nil) | |
775 | ||
776 | (defun cua--prefix-arg (arg) | |
a1506d29 | 777 | (setq cua--register |
72cc582e | 778 | (and cua-enable-register-prefix |
72cc582e | 779 | (integerp arg) (>= arg 0) (< arg 10) |
1c62c12f KS |
780 | (let* ((prefix (aref (this-command-keys) 0)) |
781 | (ctrl-u-prefix (and (integerp prefix) | |
5632c006 | 782 | (= prefix ?\C-u)))) |
a1506d29 | 783 | (cond |
5632c006 KS |
784 | ((eq cua-enable-register-prefix 'not-ctrl-u) |
785 | (not ctrl-u-prefix)) | |
786 | ((eq cua-enable-register-prefix 'ctrl-u-only) | |
787 | ctrl-u-prefix) | |
788 | (t t))) | |
72cc582e KS |
789 | (+ arg ?0))) |
790 | (if cua--register nil arg)) | |
791 | ||
72cc582e KS |
792 | |
793 | ;;; Region specific commands | |
794 | ||
5834ac92 KS |
795 | (defvar cua--last-deleted-region-pos nil) |
796 | (defvar cua--last-deleted-region-text nil) | |
797 | ||
72cc582e KS |
798 | (defun cua-delete-region () |
799 | "Delete the active region. | |
800 | Save a copy in register 0 if `cua-delete-copy-to-register-0' is non-nil." | |
801 | (interactive) | |
802 | (let ((start (mark)) (end (point))) | |
803 | (or (<= start end) | |
804 | (setq start (prog1 end (setq end start)))) | |
cf211404 | 805 | (setq cua--last-deleted-region-text (filter-buffer-substring start end)) |
72cc582e | 806 | (if cua-delete-copy-to-register-0 |
5834ac92 | 807 | (set-register ?0 cua--last-deleted-region-text)) |
72cc582e | 808 | (delete-region start end) |
a1506d29 | 809 | (setq cua--last-deleted-region-pos |
5834ac92 KS |
810 | (cons (current-buffer) |
811 | (and (consp buffer-undo-list) | |
812 | (car buffer-undo-list)))) | |
ecd61067 KS |
813 | (cua--deactivate) |
814 | (/= start end))) | |
72cc582e KS |
815 | |
816 | (defun cua-replace-region () | |
817 | "Replace the active region with the character you type." | |
818 | (interactive) | |
ae6ffe99 | 819 | (let ((not-empty (and cua-delete-selection (cua-delete-region)))) |
ecd61067 KS |
820 | (unless (eq this-original-command this-command) |
821 | (let ((overwrite-mode | |
822 | (and overwrite-mode | |
823 | not-empty | |
824 | (not (eq this-original-command 'self-insert-command))))) | |
825 | (cua--fallback))))) | |
72cc582e KS |
826 | |
827 | (defun cua-copy-region (arg) | |
828 | "Copy the region to the kill ring. | |
829 | With numeric prefix arg, copy to register 0-9 instead." | |
830 | (interactive "P") | |
831 | (setq arg (cua--prefix-arg arg)) | |
832 | (setq cua--last-killed-rectangle nil) | |
833 | (let ((start (mark)) (end (point))) | |
834 | (or (<= start end) | |
835 | (setq start (prog1 end (setq end start)))) | |
6a350b06 KS |
836 | (cond |
837 | (cua--register | |
838 | (copy-to-register cua--register start end nil)) | |
839 | ((eq this-original-command 'clipboard-kill-ring-save) | |
840 | (clipboard-kill-ring-save start end)) | |
841 | (t | |
842 | (copy-region-as-kill start end))) | |
72cc582e KS |
843 | (if cua-keep-region-after-copy |
844 | (cua--keep-active) | |
845 | (cua--deactivate)))) | |
846 | ||
847 | (defun cua-cut-region (arg) | |
848 | "Cut the region and copy to the kill ring. | |
849 | With numeric prefix arg, copy to register 0-9 instead." | |
850 | (interactive "P") | |
851 | (setq cua--last-killed-rectangle nil) | |
852 | (if buffer-read-only | |
853 | (cua-copy-region arg) | |
854 | (setq arg (cua--prefix-arg arg)) | |
855 | (let ((start (mark)) (end (point))) | |
856 | (or (<= start end) | |
857 | (setq start (prog1 end (setq end start)))) | |
6a350b06 KS |
858 | (cond |
859 | (cua--register | |
860 | (copy-to-register cua--register start end t)) | |
861 | ((eq this-original-command 'clipboard-kill-region) | |
862 | (clipboard-kill-region start end)) | |
863 | (t | |
864 | (kill-region start end)))) | |
72cc582e KS |
865 | (cua--deactivate))) |
866 | ||
867 | ;;; Generic commands for regions, rectangles, and global marks | |
868 | ||
869 | (defun cua-cancel () | |
870 | "Cancel the active region, rectangle, or global mark." | |
871 | (interactive) | |
872 | (setq mark-active nil) | |
873 | (setq cua--explicit-region-start nil) | |
874 | (if (fboundp 'cua--cancel-rectangle) | |
875 | (cua--cancel-rectangle))) | |
876 | ||
877 | (defun cua-paste (arg) | |
878 | "Paste last cut or copied region or rectangle. | |
879 | An active region is deleted before executing the command. | |
880 | With numeric prefix arg, paste from register 0-9 instead. | |
881 | If global mark is active, copy from register or one character." | |
882 | (interactive "P") | |
883 | (setq arg (cua--prefix-arg arg)) | |
884 | (let ((regtxt (and cua--register (get-register cua--register))) | |
85d392cb KS |
885 | (count (prefix-numeric-value arg)) |
886 | paste-column paste-lines) | |
72cc582e KS |
887 | (cond |
888 | ((and cua--register (not regtxt)) | |
889 | (message "Nothing in register %c" cua--register)) | |
890 | (cua--global-mark-active | |
891 | (if regtxt | |
892 | (cua--insert-at-global-mark regtxt) | |
893 | (when (not (eobp)) | |
cf211404 | 894 | (cua--insert-at-global-mark (filter-buffer-substring (point) (+ (point) count))) |
72cc582e KS |
895 | (forward-char count)))) |
896 | (buffer-read-only | |
897 | (message "Cannot paste into a read-only buffer")) | |
898 | (t | |
899 | ;; Must save register here, since delete may override reg 0. | |
900 | (if mark-active | |
72cc582e | 901 | (if cua--rectangle |
85d392cb KS |
902 | (progn |
903 | (goto-char (min (mark) (point))) | |
904 | (setq paste-column (cua--rectangle-left)) | |
905 | (setq paste-lines (cua--delete-rectangle)) | |
906 | (if (= paste-lines 1) | |
907 | (setq paste-lines nil))) ;; paste all | |
0aeeaa26 JL |
908 | ;; Before a yank command, make sure we don't yank the |
909 | ;; head of the kill-ring that really comes from the | |
910 | ;; currently active region we are going to delete | |
911 | ;; (when last-command is one that uses copy-region-as-kill | |
912 | ;; or kill-new). That would make yank a no-op. | |
913 | (if (and (string= (filter-buffer-substring (point) (mark)) | |
914 | (car kill-ring)) | |
915 | (memq last-command | |
916 | '(mouse-set-region mouse-drag-region | |
917 | mouse-save-then-kill mouse-secondary-save-then-kill))) | |
72cc582e KS |
918 | (current-kill 1)) |
919 | (cua-delete-region))) | |
920 | (cond | |
921 | (regtxt | |
922 | (cond | |
923 | ((consp regtxt) (cua--insert-rectangle regtxt)) | |
924 | ((stringp regtxt) (insert-for-yank regtxt)) | |
925 | (t (message "Unknown data in register %c" cua--register)))) | |
926 | ((and cua--last-killed-rectangle | |
927 | (eq (and kill-ring (car kill-ring)) (car cua--last-killed-rectangle))) | |
928 | (let ((pt (point))) | |
929 | (when (not (eq buffer-undo-list t)) | |
930 | (setq this-command 'cua--paste-rectangle) | |
931 | (undo-boundary) | |
932 | (setq buffer-undo-list (cons pt buffer-undo-list))) | |
85d392cb KS |
933 | (cua--insert-rectangle (cdr cua--last-killed-rectangle) |
934 | nil paste-column paste-lines) | |
72cc582e | 935 | (if arg (goto-char pt)))) |
6a350b06 KS |
936 | ((eq this-original-command 'clipboard-yank) |
937 | (clipboard-yank)) | |
ed8bc9f8 KS |
938 | ((eq this-original-command 'x-clipboard-yank) |
939 | (x-clipboard-yank)) | |
72cc582e KS |
940 | (t (yank arg))))))) |
941 | ||
c64a6023 KS |
942 | |
943 | ;; cua-paste-pop-rotate-temporarily == t mechanism: | |
944 | ;; | |
945 | ;; C-y M-y M-y => only rotates kill ring temporarily, | |
946 | ;; so next C-y yanks what previous C-y yanked, | |
947 | ;; | |
fc363578 KS |
948 | ;; M-y M-y M-y => equivalent to C-y M-y M-y |
949 | ;; | |
950 | ;; But: After another command, C-u M-y remembers the temporary | |
c64a6023 | 951 | ;; kill-ring position, so |
fc363578 | 952 | ;; C-u M-y => yanks what the last M-y yanked |
c64a6023 KS |
953 | ;; |
954 | ||
955 | (defvar cua-paste-pop-count nil) | |
956 | ||
72cc582e KS |
957 | (defun cua-paste-pop (arg) |
958 | "Replace a just-pasted text or rectangle with a different text. | |
c64a6023 KS |
959 | See `yank-pop' for details about the default behaviour. For an alternative |
960 | behaviour, see `cua-paste-pop-rotate-temporarily'." | |
72cc582e | 961 | (interactive "P") |
c64a6023 KS |
962 | (cond |
963 | ((eq last-command 'cua--paste-rectangle) | |
964 | (undo) | |
965 | (yank arg)) | |
966 | ((not cua-paste-pop-rotate-temporarily) | |
967 | (yank-pop (prefix-numeric-value arg))) | |
968 | (t | |
969 | (let ((rotate (if (consp arg) 1 (prefix-numeric-value arg)))) | |
970 | (cond | |
971 | ((or (null cua-paste-pop-count) | |
972 | (eq last-command 'yank) | |
973 | (eq last-command 'cua-paste)) | |
974 | (setq cua-paste-pop-count rotate) | |
975 | (setq last-command 'yank) | |
976 | (yank-pop cua-paste-pop-count)) | |
fc363578 KS |
977 | ((and (eq last-command 'cua-paste-pop) (not (consp arg))) |
978 | (setq cua-paste-pop-count (+ cua-paste-pop-count rotate)) | |
c64a6023 KS |
979 | (setq last-command 'yank) |
980 | (yank-pop cua-paste-pop-count)) | |
981 | (t | |
fc363578 KS |
982 | (setq cua-paste-pop-count |
983 | (if (consp arg) (+ cua-paste-pop-count rotate -1) 1)) | |
c64a6023 KS |
984 | (yank (1+ cua-paste-pop-count))))) |
985 | ;; Undo rotating the kill-ring, so next C-y will | |
986 | ;; yank the original head. | |
fc363578 | 987 | (setq kill-ring-yank-pointer kill-ring) |
c64a6023 | 988 | (setq this-command 'cua-paste-pop)))) |
72cc582e KS |
989 | |
990 | (defun cua-exchange-point-and-mark (arg) | |
991 | "Exchanges point and mark, but don't activate the mark. | |
992 | Activates the mark if a prefix argument is given." | |
993 | (interactive "P") | |
994 | (if arg | |
995 | (setq mark-active t) | |
996 | (let (mark-active) | |
997 | (exchange-point-and-mark) | |
998 | (if cua--rectangle | |
999 | (cua--rectangle-corner 0))))) | |
1000 | ||
34a63289 KS |
1001 | ;; Typed text that replaced the highlighted region. |
1002 | (defvar cua--repeat-replace-text nil) | |
1003 | ||
1004 | (defun cua-repeat-replace-region (arg) | |
1005 | "Repeat replacing text of highlighted region with typed text. | |
c77d7c92 JB |
1006 | Searches for the next stretch of text identical to the region last |
1007 | replaced by typing text over it and replaces it with the same stretch | |
5834ac92 | 1008 | of text." |
34a63289 | 1009 | (interactive "P") |
5834ac92 KS |
1010 | (when cua--last-deleted-region-pos |
1011 | (save-excursion | |
1012 | (save-restriction | |
1013 | (set-buffer (car cua--last-deleted-region-pos)) | |
1014 | (widen) | |
1015 | ;; Find the text that replaced the region via the undo list. | |
1016 | (let ((ul buffer-undo-list) | |
1017 | (elt (cdr cua--last-deleted-region-pos)) | |
1018 | u s e) | |
1019 | (when elt | |
1020 | (while (consp ul) | |
1021 | (setq u (car ul) ul (cdr ul)) | |
1022 | (cond | |
1023 | ((eq u elt) ;; got it | |
1024 | (setq ul nil)) | |
1025 | ((and (consp u) (integerp (car u)) (integerp (cdr u))) | |
1026 | (if (and s (= (cdr u) s)) | |
1027 | (setq s (car u)) | |
1028 | (setq s (car u) e (cdr u))))))) | |
c64a6023 KS |
1029 | (cond ((and s e (<= s e) (= s (mark t))) |
1030 | (setq cua--repeat-replace-text | |
1031 | (filter-buffer-substring s e nil t))) | |
1032 | ((and (null s) (eq u elt)) ;; nothing inserted | |
1033 | (setq cua--repeat-replace-text | |
1034 | "")) | |
1035 | (t | |
1036 | (message "Cannot locate replacement text")))))) | |
5834ac92 KS |
1037 | (setq cua--last-deleted-region-pos nil)) |
1038 | (if (and cua--last-deleted-region-text | |
1039 | cua--repeat-replace-text | |
1040 | (search-forward cua--last-deleted-region-text nil t nil)) | |
1041 | (replace-match cua--repeat-replace-text arg t))) | |
34a63289 | 1042 | |
72cc582e KS |
1043 | (defun cua-help-for-region (&optional help) |
1044 | "Show region specific help in echo area." | |
1045 | (interactive) | |
a1506d29 | 1046 | (message |
72cc582e KS |
1047 | (concat (if help "C-?:help " "") |
1048 | "C-z:undo C-x:cut C-c:copy C-v:paste S-ret:rect"))) | |
1049 | ||
1050 | ||
1051 | ;;; Shift activated / extended region | |
1052 | ||
c64a6023 KS |
1053 | (defun cua-pop-to-last-change () |
1054 | (let ((undo-list buffer-undo-list) | |
1055 | pos elt) | |
1056 | (while (and (not pos) | |
1057 | (consp undo-list)) | |
1058 | (setq elt (car undo-list) | |
1059 | undo-list (cdr undo-list)) | |
1060 | (cond | |
1061 | ((integerp elt) | |
1062 | (setq pos elt)) | |
1063 | ((not (consp elt))) | |
1064 | ((and (integerp (cdr elt)) | |
1065 | (or (integerp (car elt)) (stringp (car elt)))) | |
1066 | (setq pos (cdr elt))) | |
1067 | ((and (eq (car elt) 'apply) (consp (cdr elt)) (integerp (cadr elt))) | |
1068 | (setq pos (nth 3 elt))))) | |
1069 | (when (and pos | |
1070 | (/= pos (point)) | |
1071 | (>= pos (point-min)) (<= pos (point-max))) | |
1072 | (goto-char pos) | |
1073 | t))) | |
1074 | ||
72cc582e KS |
1075 | (defun cua-set-mark (&optional arg) |
1076 | "Set mark at where point is, clear mark, or jump to mark. | |
f45a6831 KS |
1077 | |
1078 | With no prefix argument, clear mark if already set. Otherwise, set | |
1079 | mark, and push old mark position on local mark ring; also push mark on | |
3ffc8a8a | 1080 | global mark ring if last mark was set in another buffer. |
f45a6831 KS |
1081 | |
1082 | With argument, jump to mark, and pop a new position for mark off | |
c64a6023 | 1083 | the local mark ring (this does not affect the global mark ring). |
f45a6831 | 1084 | Use \\[pop-global-mark] to jump to a mark off the global mark ring |
c64a6023 KS |
1085 | \(see `pop-global-mark'). |
1086 | ||
1087 | If `cua-auto-mark-last-change' is non-nil, this command behaves as if there | |
1088 | was an implicit mark at the position of the last buffer change. | |
ce92443f KS |
1089 | |
1090 | Repeating the command without the prefix jumps to the next position | |
c64a6023 | 1091 | off the local (or global) mark ring. |
f45a6831 KS |
1092 | |
1093 | With a double \\[universal-argument] prefix argument, unconditionally set mark." | |
72cc582e | 1094 | (interactive "P") |
72cc582e | 1095 | (cond |
f45a6831 KS |
1096 | ((and (consp arg) (> (prefix-numeric-value arg) 4)) |
1097 | (push-mark-command nil)) | |
fc803e8d | 1098 | ((eq last-command 'pop-to-mark-command) |
f45a6831 KS |
1099 | (setq this-command 'pop-to-mark-command) |
1100 | (pop-to-mark-command)) | |
ce92443f | 1101 | ((and (eq last-command 'pop-global-mark) (not arg)) |
f45a6831 KS |
1102 | (setq this-command 'pop-global-mark) |
1103 | (pop-global-mark)) | |
72cc582e | 1104 | (arg |
fc803e8d | 1105 | (setq this-command 'pop-to-mark-command) |
c64a6023 KS |
1106 | (or (and cua-auto-mark-last-change |
1107 | (cua-pop-to-last-change)) | |
1108 | (pop-to-mark-command))) | |
ae6ffe99 | 1109 | ((and cua-toggle-set-mark mark-active) |
72cc582e KS |
1110 | (cua--deactivate) |
1111 | (message "Mark Cleared")) | |
1112 | (t | |
fc803e8d | 1113 | (push-mark-command nil nil) |
72cc582e KS |
1114 | (setq cua--explicit-region-start t) |
1115 | (setq cua--last-region-shifted nil) | |
1116 | (if cua-enable-region-auto-help | |
1117 | (cua-help-for-region t))))) | |
1118 | ||
82851d10 KS |
1119 | ;;; Scrolling commands which does not signal errors at top/bottom |
1120 | ;;; of buffer at first key-press (instead moves to top/bottom | |
1121 | ;;; of buffer). | |
1122 | ||
1123 | (defun cua-scroll-up (&optional arg) | |
1124 | "Scroll text of current window upward ARG lines; or near full screen if no ARG. | |
1125 | If window cannot be scrolled further, move cursor to bottom line instead. | |
1126 | A near full screen is `next-screen-context-lines' less than a full screen. | |
1127 | Negative ARG means scroll downward. | |
1128 | If ARG is the atom `-', scroll downward by nearly full screen." | |
1129 | (interactive "P") | |
1130 | (cond | |
1131 | ((eq arg '-) (cua-scroll-down nil)) | |
1132 | ((< (prefix-numeric-value arg) 0) | |
1133 | (cua-scroll-down (- (prefix-numeric-value arg)))) | |
1134 | ((eobp) | |
1135 | (scroll-up arg)) ; signal error | |
1136 | (t | |
1137 | (condition-case nil | |
1138 | (scroll-up arg) | |
1139 | (end-of-buffer (goto-char (point-max))))))) | |
1140 | ||
4905133f KS |
1141 | (put 'cua-scroll-up 'CUA 'move) |
1142 | ||
82851d10 KS |
1143 | (defun cua-scroll-down (&optional arg) |
1144 | "Scroll text of current window downward ARG lines; or near full screen if no ARG. | |
1145 | If window cannot be scrolled further, move cursor to top line instead. | |
1146 | A near full screen is `next-screen-context-lines' less than a full screen. | |
1147 | Negative ARG means scroll upward. | |
1148 | If ARG is the atom `-', scroll upward by nearly full screen." | |
1149 | (interactive "P") | |
1150 | (cond | |
1151 | ((eq arg '-) (cua-scroll-up nil)) | |
1152 | ((< (prefix-numeric-value arg) 0) | |
1153 | (cua-scroll-up (- (prefix-numeric-value arg)))) | |
1154 | ((bobp) | |
1155 | (scroll-down arg)) ; signal error | |
1156 | (t | |
1157 | (condition-case nil | |
1158 | (scroll-down arg) | |
1159 | (beginning-of-buffer (goto-char (point-min))))))) | |
1160 | ||
ec503c28 | 1161 | (put 'cua-scroll-down 'CUA 'move) |
4905133f | 1162 | |
72cc582e KS |
1163 | ;;; Cursor indications |
1164 | ||
1165 | (defun cua--update-indications () | |
2ed2415d KS |
1166 | (let* ((cursor |
1167 | (cond | |
1168 | ((and cua--global-mark-active | |
1169 | cua-global-mark-cursor-color) | |
1170 | cua-global-mark-cursor-color) | |
1171 | ((and buffer-read-only | |
1172 | cua-read-only-cursor-color) | |
1173 | cua-read-only-cursor-color) | |
85d392cb | 1174 | ((and cua-overwrite-cursor-color overwrite-mode) |
2ed2415d KS |
1175 | cua-overwrite-cursor-color) |
1176 | (t cua-normal-cursor-color))) | |
1177 | (color (if (consp cursor) (cdr cursor) cursor)) | |
1178 | (type (if (consp cursor) (car cursor) cursor))) | |
1179 | (if (and color | |
1180 | (stringp color) | |
1181 | (not (equal color (frame-parameter nil 'cursor-color)))) | |
1182 | (set-cursor-color color)) | |
1183 | (if (and type | |
1184 | (symbolp type) | |
6aa06cd8 | 1185 | (not (eq type default-cursor-type))) |
2ed2415d | 1186 | (setq default-cursor-type type)))) |
72cc582e KS |
1187 | |
1188 | ||
1189 | ;;; Pre-command hook | |
1190 | ||
01096a7b | 1191 | (defun cua--pre-command-handler-1 () |
53c11b7e KS |
1192 | ;; Cancel prefix key timeout if user enters another key. |
1193 | (when cua--prefix-override-timer | |
1194 | (if (timerp cua--prefix-override-timer) | |
1195 | (cancel-timer cua--prefix-override-timer)) | |
1196 | (setq cua--prefix-override-timer nil)) | |
1197 | ||
1198 | (cond | |
1199 | ;; Only symbol commands can have necessary properties | |
1200 | ((not (symbolp this-command)) | |
1201 | nil) | |
1202 | ||
1203 | ;; Handle delete-selection property on non-movement commands | |
1204 | ((not (eq (get this-command 'CUA) 'move)) | |
1205 | (when (and mark-active (not deactivate-mark)) | |
1206 | (let* ((ds (or (get this-command 'delete-selection) | |
1207 | (get this-command 'pending-delete))) | |
1208 | (nc (cond | |
1209 | ((not ds) nil) | |
1210 | ((eq ds 'yank) | |
1211 | 'cua-paste) | |
1212 | ((eq ds 'kill) | |
1213 | (if cua--rectangle | |
1214 | 'cua-copy-rectangle | |
1215 | 'cua-copy-region)) | |
1216 | ((eq ds 'supersede) | |
1217 | (if cua--rectangle | |
1218 | 'cua-delete-rectangle | |
1219 | 'cua-delete-region)) | |
1220 | (t | |
1221 | (if cua--rectangle | |
1222 | 'cua-delete-rectangle ;; replace? | |
1223 | 'cua-replace-region))))) | |
1224 | (if nc | |
1225 | (setq this-original-command this-command | |
1226 | this-command nc))))) | |
1227 | ||
1228 | ;; Handle shifted cursor keys and other movement commands. | |
1229 | ;; If region is not active, region is activated if key is shifted. | |
1230 | ;; If region is active, region is cancelled if key is unshifted (and region not started with C-SPC). | |
1231 | ;; If rectangle is active, expand rectangle in specified direction and ignore the movement. | |
1232 | ((if window-system | |
1233 | (memq 'shift (event-modifiers | |
1234 | (aref (this-single-command-raw-keys) 0))) | |
1235 | (or | |
1236 | (memq 'shift (event-modifiers | |
1237 | (aref (this-single-command-keys) 0))) | |
1238 | ;; See if raw escape sequence maps to a shifted event, e.g. S-up or C-S-home. | |
1239 | (and (boundp 'function-key-map) | |
1240 | function-key-map | |
1241 | (let ((ev (lookup-key function-key-map | |
1242 | (this-single-command-raw-keys)))) | |
1243 | (and (vector ev) | |
1244 | (symbolp (setq ev (aref ev 0))) | |
1245 | (string-match "S-" (symbol-name ev))))))) | |
1246 | (unless mark-active | |
1247 | (push-mark-command nil t)) | |
1248 | (setq cua--last-region-shifted t) | |
1249 | (setq cua--explicit-region-start nil)) | |
1250 | ||
1251 | ;; Set mark if user explicitly said to do so | |
1252 | ((or cua--explicit-region-start cua--rectangle) | |
1253 | (unless mark-active | |
1254 | (push-mark-command nil nil))) | |
1255 | ||
1256 | ;; Else clear mark after this command. | |
1257 | (t | |
1258 | ;; If we set mark-active to nil here, the region highlight will not be | |
1259 | ;; removed by the direct_output_ commands. | |
1260 | (setq deactivate-mark t))) | |
1261 | ||
1262 | ;; Detect extension of rectangles by mouse or other movement | |
1263 | (setq cua--buffer-and-point-before-command | |
1264 | (if cua--rectangle (cons (current-buffer) (point))))) | |
01096a7b | 1265 | |
72cc582e | 1266 | (defun cua--pre-command-handler () |
01096a7b KS |
1267 | (when cua-mode |
1268 | (condition-case nil | |
1269 | (cua--pre-command-handler-1) | |
1270 | (error nil)))) | |
72cc582e KS |
1271 | |
1272 | ;;; Post-command hook | |
1273 | ||
01096a7b KS |
1274 | (defun cua--post-command-handler-1 () |
1275 | (when cua--global-mark-active | |
1276 | (cua--global-mark-post-command)) | |
1277 | (when (fboundp 'cua--rectangle-post-command) | |
1278 | (cua--rectangle-post-command)) | |
1279 | (setq cua--buffer-and-point-before-command nil) | |
1280 | (if (or (not mark-active) deactivate-mark) | |
1281 | (setq cua--explicit-region-start nil)) | |
1282 | ||
1283 | ;; Debugging | |
1284 | (if cua--debug | |
1285 | (cond | |
1286 | (cua--rectangle (cua--rectangle-assert)) | |
1287 | (mark-active (message "Mark=%d Point=%d Expl=%s" | |
1288 | (mark t) (point) cua--explicit-region-start)))) | |
72cc582e | 1289 | |
01096a7b KS |
1290 | ;; Disable transient-mark-mode if rectangle active in current buffer. |
1291 | (if (not (window-minibuffer-p (selected-window))) | |
1292 | (setq transient-mark-mode (and (not cua--rectangle) | |
1293 | (if cua-highlight-region-shift-only | |
1294 | (not cua--explicit-region-start) | |
1295 | t)))) | |
1296 | (if cua-enable-cursor-indications | |
1297 | (cua--update-indications)) | |
72cc582e | 1298 | |
01096a7b KS |
1299 | (cua--select-keymaps)) |
1300 | ||
1301 | (defun cua--post-command-handler () | |
1302 | (when cua-mode | |
1303 | (condition-case nil | |
1304 | (cua--post-command-handler-1) | |
1305 | (error nil)))) | |
72cc582e KS |
1306 | |
1307 | ||
1308 | ;;; Keymaps | |
1309 | ||
1638bf54 KS |
1310 | ;; Cached value of actual cua-rectangle-modifier-key |
1311 | (defvar cua--rectangle-modifier-key 'meta) | |
1312 | ||
72cc582e KS |
1313 | (defun cua--M/H-key (map key fct) |
1314 | ;; bind H-KEY or M-KEY to FCT in MAP | |
72cc582e | 1315 | (unless (listp key) (setq key (list key))) |
1638bf54 | 1316 | (define-key map (vector (cons cua--rectangle-modifier-key key)) fct)) |
72cc582e | 1317 | |
20023b9c KS |
1318 | (defun cua--self-insert-char-p (def) |
1319 | ;; Return DEF if current key sequence is self-inserting in | |
1320 | ;; global-map. | |
1321 | (if (memq (global-key-binding (this-single-command-keys)) | |
1322 | '(self-insert-command self-insert-iso)) | |
1323 | def nil)) | |
1324 | ||
a23a8440 KS |
1325 | (defvar cua-global-keymap (make-sparse-keymap) |
1326 | "Global keymap for cua-mode; users may add to this keymap.") | |
1327 | ||
72cc582e KS |
1328 | (defvar cua--cua-keys-keymap (make-sparse-keymap)) |
1329 | (defvar cua--prefix-override-keymap (make-sparse-keymap)) | |
1330 | (defvar cua--prefix-repeat-keymap (make-sparse-keymap)) | |
1331 | (defvar cua--global-mark-keymap (make-sparse-keymap)) ; Initalized when cua-gmrk.el is loaded | |
1332 | (defvar cua--rectangle-keymap (make-sparse-keymap)) ; Initalized when cua-rect.el is loaded | |
1333 | (defvar cua--region-keymap (make-sparse-keymap)) | |
1334 | ||
1335 | (defvar cua--ena-cua-keys-keymap nil) | |
1336 | (defvar cua--ena-prefix-override-keymap nil) | |
1337 | (defvar cua--ena-prefix-repeat-keymap nil) | |
1338 | (defvar cua--ena-region-keymap nil) | |
1339 | (defvar cua--ena-global-mark-keymap nil) | |
1340 | ||
a23a8440 KS |
1341 | (defvar cua--keymap-alist |
1342 | `((cua--ena-prefix-override-keymap . ,cua--prefix-override-keymap) | |
1343 | (cua--ena-prefix-repeat-keymap . ,cua--prefix-repeat-keymap) | |
1344 | (cua--ena-cua-keys-keymap . ,cua--cua-keys-keymap) | |
1345 | (cua--ena-global-mark-keymap . ,cua--global-mark-keymap) | |
1346 | (cua--rectangle . ,cua--rectangle-keymap) | |
1347 | (cua--ena-region-keymap . ,cua--region-keymap) | |
1348 | (cua-mode . ,cua-global-keymap))) | |
1349 | ||
1350 | (defun cua--select-keymaps () | |
1351 | ;; Setup conditions for selecting the proper keymaps in cua--keymap-alist. | |
72cc582e KS |
1352 | (setq cua--ena-region-keymap |
1353 | (and mark-active (not deactivate-mark))) | |
1354 | (setq cua--ena-prefix-override-keymap | |
1355 | (and cua--ena-region-keymap | |
1356 | cua-enable-cua-keys | |
63e6f5b3 | 1357 | (not cua-inhibit-cua-keys) |
72cc582e KS |
1358 | (or (eq cua-enable-cua-keys t) |
1359 | (not cua--explicit-region-start)) | |
1360 | (not executing-kbd-macro) | |
1361 | (not cua--prefix-override-timer))) | |
1362 | (setq cua--ena-prefix-repeat-keymap | |
1363 | (and cua--ena-region-keymap | |
186bccc3 KS |
1364 | (or (timerp cua--prefix-override-timer) |
1365 | (eq cua--prefix-override-timer 'shift)))) | |
72cc582e KS |
1366 | (setq cua--ena-cua-keys-keymap |
1367 | (and cua-enable-cua-keys | |
63e6f5b3 | 1368 | (not cua-inhibit-cua-keys) |
72cc582e KS |
1369 | (or (eq cua-enable-cua-keys t) |
1370 | cua--last-region-shifted))) | |
1371 | (setq cua--ena-global-mark-keymap | |
1372 | (and cua--global-mark-active | |
1373 | (not (window-minibuffer-p))))) | |
1374 | ||
1375 | (defvar cua--keymaps-initalized nil) | |
1376 | ||
186bccc3 KS |
1377 | (defun cua--shift-control-prefix (prefix arg) |
1378 | ;; handle S-C-x and S-C-c by emulating the fast double prefix function. | |
1379 | ;; Don't record this command | |
1380 | (setq this-command last-command) | |
1381 | ;; Restore the prefix arg | |
1382 | (setq prefix-arg arg) | |
1383 | (reset-this-command-lengths) | |
1384 | ;; Activate the cua--prefix-repeat-keymap | |
1385 | (setq cua--prefix-override-timer 'shift) | |
1386 | ;; Push duplicate keys back on the event queue | |
1387 | (setq unread-command-events (cons prefix (cons prefix unread-command-events)))) | |
1388 | ||
1389 | (defun cua--shift-control-c-prefix (arg) | |
1390 | (interactive "P") | |
1391 | (cua--shift-control-prefix ?\C-c arg)) | |
1392 | ||
1393 | (defun cua--shift-control-x-prefix (arg) | |
1394 | (interactive "P") | |
1395 | (cua--shift-control-prefix ?\C-x arg)) | |
1396 | ||
72cc582e | 1397 | (defun cua--init-keymaps () |
1638bf54 KS |
1398 | ;; Cache actual rectangle modifier key. |
1399 | (setq cua--rectangle-modifier-key | |
1400 | (if (and cua-rectangle-modifier-key | |
1401 | (memq window-system '(x))) | |
1402 | cua-rectangle-modifier-key | |
1403 | 'meta)) | |
1404 | ;; C-return always toggles rectangle mark | |
1cb225da | 1405 | (define-key cua-global-keymap cua-rectangle-mark-key 'cua-set-rectangle-mark) |
1638bf54 KS |
1406 | (unless (eq cua--rectangle-modifier-key 'meta) |
1407 | (cua--M/H-key cua-global-keymap ?\s 'cua-set-rectangle-mark) | |
1408 | (define-key cua-global-keymap | |
1409 | (vector (list cua--rectangle-modifier-key 'mouse-1)) 'cua-mouse-set-rectangle-mark)) | |
72cc582e | 1410 | |
1023b169 | 1411 | (define-key cua-global-keymap [(shift control ?\s)] 'cua-toggle-global-mark) |
72cc582e KS |
1412 | |
1413 | ;; replace region with rectangle or element on kill ring | |
1414 | (define-key cua-global-keymap [remap yank] 'cua-paste) | |
1415 | (define-key cua-global-keymap [remap clipboard-yank] 'cua-paste) | |
ed8bc9f8 | 1416 | (define-key cua-global-keymap [remap x-clipboard-yank] 'cua-paste) |
72cc582e KS |
1417 | ;; replace current yank with previous kill ring element |
1418 | (define-key cua-global-keymap [remap yank-pop] 'cua-paste-pop) | |
1419 | ;; set mark | |
1420 | (define-key cua-global-keymap [remap set-mark-command] 'cua-set-mark) | |
72cc582e | 1421 | |
82851d10 KS |
1422 | ;; scrolling |
1423 | (define-key cua-global-keymap [remap scroll-up] 'cua-scroll-up) | |
1424 | (define-key cua-global-keymap [remap scroll-down] 'cua-scroll-down) | |
1425 | ||
72cc582e | 1426 | (define-key cua--cua-keys-keymap [(control x) timeout] 'kill-region) |
72cc582e | 1427 | (define-key cua--cua-keys-keymap [(control c) timeout] 'copy-region-as-kill) |
72cc582e KS |
1428 | (define-key cua--cua-keys-keymap [(control z)] 'undo) |
1429 | (define-key cua--cua-keys-keymap [(control v)] 'yank) | |
34a63289 | 1430 | (define-key cua--cua-keys-keymap [(meta v)] 'cua-repeat-replace-region) |
72cc582e KS |
1431 | (define-key cua--cua-keys-keymap [remap exchange-point-and-mark] 'cua-exchange-point-and-mark) |
1432 | ||
1433 | (define-key cua--prefix-override-keymap [(control x)] 'cua--prefix-override-handler) | |
1434 | (define-key cua--prefix-override-keymap [(control c)] 'cua--prefix-override-handler) | |
a1506d29 | 1435 | |
72cc582e KS |
1436 | (define-key cua--prefix-repeat-keymap [(control x) (control x)] 'cua--prefix-repeat-handler) |
1437 | (define-key cua--prefix-repeat-keymap [(control x) up] 'cua--prefix-cut-handler) | |
1438 | (define-key cua--prefix-repeat-keymap [(control x) down] 'cua--prefix-cut-handler) | |
1439 | (define-key cua--prefix-repeat-keymap [(control x) left] 'cua--prefix-cut-handler) | |
1440 | (define-key cua--prefix-repeat-keymap [(control x) right] 'cua--prefix-cut-handler) | |
1441 | (define-key cua--prefix-repeat-keymap [(control c) (control c)] 'cua--prefix-repeat-handler) | |
1442 | (define-key cua--prefix-repeat-keymap [(control c) up] 'cua--prefix-copy-handler) | |
1443 | (define-key cua--prefix-repeat-keymap [(control c) down] 'cua--prefix-copy-handler) | |
1444 | (define-key cua--prefix-repeat-keymap [(control c) left] 'cua--prefix-copy-handler) | |
1445 | (define-key cua--prefix-repeat-keymap [(control c) right] 'cua--prefix-copy-handler) | |
1446 | ||
a1506d29 | 1447 | ;; Enable shifted fallbacks for C-x and C-c when region is active |
186bccc3 KS |
1448 | (define-key cua--region-keymap [(shift control x)] 'cua--shift-control-x-prefix) |
1449 | (define-key cua--region-keymap [(shift control c)] 'cua--shift-control-c-prefix) | |
1450 | ||
72cc582e KS |
1451 | ;; replace current region |
1452 | (define-key cua--region-keymap [remap self-insert-command] 'cua-replace-region) | |
1453 | (define-key cua--region-keymap [remap self-insert-iso] 'cua-replace-region) | |
1454 | (define-key cua--region-keymap [remap insert-register] 'cua-replace-region) | |
1455 | (define-key cua--region-keymap [remap newline-and-indent] 'cua-replace-region) | |
1456 | (define-key cua--region-keymap [remap newline] 'cua-replace-region) | |
1457 | (define-key cua--region-keymap [remap open-line] 'cua-replace-region) | |
1458 | ;; delete current region | |
1459 | (define-key cua--region-keymap [remap delete-backward-char] 'cua-delete-region) | |
1460 | (define-key cua--region-keymap [remap backward-delete-char] 'cua-delete-region) | |
1461 | (define-key cua--region-keymap [remap backward-delete-char-untabify] 'cua-delete-region) | |
1462 | (define-key cua--region-keymap [remap delete-char] 'cua-delete-region) | |
1463 | ;; kill region | |
1464 | (define-key cua--region-keymap [remap kill-region] 'cua-cut-region) | |
6a350b06 | 1465 | (define-key cua--region-keymap [remap clipboard-kill-region] 'cua-cut-region) |
72cc582e KS |
1466 | ;; copy region |
1467 | (define-key cua--region-keymap [remap copy-region-as-kill] 'cua-copy-region) | |
1468 | (define-key cua--region-keymap [remap kill-ring-save] 'cua-copy-region) | |
6a350b06 | 1469 | (define-key cua--region-keymap [remap clipboard-kill-ring-save] 'cua-copy-region) |
72cc582e KS |
1470 | ;; cancel current region/rectangle |
1471 | (define-key cua--region-keymap [remap keyboard-escape-quit] 'cua-cancel) | |
1472 | (define-key cua--region-keymap [remap keyboard-quit] 'cua-cancel) | |
1473 | ) | |
1474 | ||
4905133f KS |
1475 | |
1476 | ;; Setup standard movement commands to be recognized by CUA. | |
1477 | ||
1478 | (dolist (cmd | |
1479 | '(forward-char backward-char | |
1480 | next-line previous-line | |
1481 | forward-word backward-word | |
1482 | end-of-line beginning-of-line | |
bab88420 | 1483 | move-end-of-line move-beginning-of-line |
4905133f KS |
1484 | end-of-buffer beginning-of-buffer |
1485 | scroll-up scroll-down | |
72662103 KS |
1486 | up-list down-list backward-up-list |
1487 | end-of-defun beginning-of-defun | |
1488 | forward-sexp backward-sexp | |
1489 | forward-list backward-list | |
4905133f KS |
1490 | forward-sentence backward-sentence |
1491 | forward-paragraph backward-paragraph)) | |
1492 | (put cmd 'CUA 'move)) | |
1493 | ||
cadc926b KS |
1494 | ;; State prior to enabling cua-mode |
1495 | ;; Value is a list with the following elements: | |
1496 | ;; transient-mark-mode | |
1497 | ;; delete-selection-mode | |
1498 | ;; pc-selection-mode | |
1499 | ||
1500 | (defvar cua--saved-state nil) | |
72cc582e KS |
1501 | |
1502 | ;;;###autoload | |
80d9508a | 1503 | (define-minor-mode cua-mode |
72cc582e | 1504 | "Toggle CUA key-binding mode. |
3685c8a4 KS |
1505 | When enabled, using shifted movement keys will activate the |
1506 | region (and highlight the region using `transient-mark-mode'), | |
1507 | and typed text replaces the active selection. | |
1508 | ||
1509 | Also when enabled, you can use C-z, C-x, C-c, and C-v to undo, | |
1510 | cut, copy, and paste in addition to the normal Emacs bindings. | |
1511 | The C-x and C-c keys only do cut and copy when the region is | |
1512 | active, so in most cases, they do not conflict with the normal | |
1513 | function of these prefix keys. | |
1514 | ||
1515 | If you really need to perform a command which starts with one of | |
1516 | the prefix keys even when the region is active, you have three | |
1517 | options: | |
1518 | - press the prefix key twice very quickly (within 0.2 seconds), | |
1023b169 | 1519 | - press the prefix key and the following key within 0.2 seconds, or |
3685c8a4 KS |
1520 | - use the SHIFT key with the prefix key, i.e. C-S-x or C-S-c. |
1521 | ||
1522 | You can customize `cua-enable-cua-keys' to completely disable the | |
1523 | CUA bindings, or `cua-prefix-override-inhibit-delay' to change | |
2b3726c0 KS |
1524 | the prefix fallback behavior. |
1525 | ||
c36f1e67 LT |
1526 | CUA mode manages Transient Mark mode internally. Trying to disable |
1527 | Transient Mark mode while CUA mode is enabled does not work; if you | |
2b3726c0 KS |
1528 | only want to highlight the region when it is selected using a |
1529 | shifted movement key, set `cua-highlight-region-shift-only'." | |
80d9508a | 1530 | :global t |
ca0f8d34 | 1531 | :group 'cua |
1cb225da KS |
1532 | :set-after '(cua-enable-modeline-indications |
1533 | cua-rectangle-mark-key cua-rectangle-modifier-key) | |
80d9508a SM |
1534 | :require 'cua-base |
1535 | :link '(emacs-commentary-link "cua-base.el") | |
72cc582e KS |
1536 | (setq mark-even-if-inactive t) |
1537 | (setq highlight-nonselected-windows nil) | |
72cc582e KS |
1538 | |
1539 | (unless cua--keymaps-initalized | |
1540 | (cua--init-keymaps) | |
1541 | (setq cua--keymaps-initalized t)) | |
1542 | ||
1543 | (if cua-mode | |
1544 | (progn | |
1545 | (add-hook 'pre-command-hook 'cua--pre-command-handler) | |
1546 | (add-hook 'post-command-hook 'cua--post-command-handler) | |
1547 | (if (and cua-enable-modeline-indications (not (assoc 'cua-mode minor-mode-alist))) | |
1548 | (setq minor-mode-alist (cons '(cua-mode cua--status-string) minor-mode-alist))) | |
2ed2415d KS |
1549 | (if cua-enable-cursor-indications |
1550 | (cua--update-indications))) | |
1551 | ||
72cc582e KS |
1552 | (remove-hook 'pre-command-hook 'cua--pre-command-handler) |
1553 | (remove-hook 'post-command-hook 'cua--post-command-handler)) | |
a23a8440 KS |
1554 | |
1555 | (if (not cua-mode) | |
1556 | (setq emulation-mode-map-alists (delq 'cua--keymap-alist emulation-mode-map-alists)) | |
1a2f4b9f | 1557 | (add-to-ordered-list 'emulation-mode-map-alists 'cua--keymap-alist 400) |
a23a8440 KS |
1558 | (cua--select-keymaps)) |
1559 | ||
cadc926b KS |
1560 | (cond |
1561 | (cua-mode | |
1562 | (setq cua--saved-state | |
1563 | (list | |
1564 | transient-mark-mode | |
1565 | (and (boundp 'delete-selection-mode) delete-selection-mode) | |
1566 | (and (boundp 'pc-selection-mode) pc-selection-mode))) | |
1567 | (if (and (boundp 'delete-selection-mode) delete-selection-mode) | |
d7672cf8 | 1568 | (delete-selection-mode -1)) |
cadc926b | 1569 | (if (and (boundp 'pc-selection-mode) pc-selection-mode) |
d7672cf8 | 1570 | (pc-selection-mode -1)) |
ef2887a2 | 1571 | (cua--deactivate) |
cadc926b KS |
1572 | (setq transient-mark-mode (and cua-mode |
1573 | (if cua-highlight-region-shift-only | |
1574 | (not cua--explicit-region-start) | |
80d9508a | 1575 | t)))) |
cadc926b KS |
1576 | (cua--saved-state |
1577 | (setq transient-mark-mode (car cua--saved-state)) | |
1578 | (if (nth 1 cua--saved-state) | |
1579 | (delete-selection-mode 1)) | |
1580 | (if (nth 2 cua--saved-state) | |
1581 | (pc-selection-mode 1)) | |
1582 | (if (interactive-p) | |
1583 | (message "CUA mode disabled.%s%s%s%s" | |
1584 | (if (nth 1 cua--saved-state) " Delete-Selection" "") | |
1585 | (if (and (nth 1 cua--saved-state) (nth 2 cua--saved-state)) " and" "") | |
1586 | (if (nth 2 cua--saved-state) " PC-Selection" "") | |
1587 | (if (or (nth 1 cua--saved-state) (nth 2 cua--saved-state)) " enabled" ""))) | |
80d9508a | 1588 | (setq cua--saved-state nil)))) |
72cc582e | 1589 | |
01096a7b KS |
1590 | |
1591 | ;;;###autoload | |
1592 | (defun cua-selection-mode (arg) | |
1593 | "Enable CUA selection mode without the C-z/C-x/C-c/C-v bindings." | |
1594 | (interactive "P") | |
1595 | (setq-default cua-enable-cua-keys nil) | |
1596 | (cua-mode arg)) | |
1597 | ||
1598 | ||
72cc582e | 1599 | (defun cua-debug () |
c77d7c92 | 1600 | "Toggle CUA debugging." |
72cc582e KS |
1601 | (interactive) |
1602 | (setq cua--debug (not cua--debug))) | |
1603 | ||
06f8e605 | 1604 | |
f1cb14f8 KS |
1605 | (provide 'cua) |
1606 | ||
ab5796a9 | 1607 | ;;; arch-tag: 21fb6289-ba25-4fee-bfdc-f9fb351acf05 |
72cc582e | 1608 | ;;; cua-base.el ends here |