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