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