lisp/s-region.el

   1 ;;; s-region.el --- set region using shift key
   2
   3 ;; Copyright (C) 1994, 1995, 2001, 2002, 2003, 2004,
   4 ;;   2005, 2006, 2007, 2008 Free Software Foundation, Inc.
   5
   6 ;; Author: Morten Welinder <terra@diku.dk>
   7 ;; Keywords: terminals
   8 ;; Favourite-brand-of-beer: None, I hate beer.
   9
  10 ;; This file is part of GNU Emacs.
  11
  12 ;; GNU Emacs is free software: you can redistribute it and/or modify
  13 ;; it under the terms of the GNU General Public License as published by
  14 ;; the Free Software Foundation, either version 3 of the License, or
  15 ;; (at your option) any later version.
  16
  17 ;; GNU Emacs is distributed in the hope that it will be useful,
  18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 ;; GNU General Public License for more details.
  21
  22 ;; You should have received a copy of the GNU General Public License
  23 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  24
  25 ;;; Commentary:
  26
  27 ;; Having loaded this code you can set the region by holding down the
  28 ;; shift key and move the cursor to the other end of the region.  The
  29 ;; functionality provided by this code is similar to that provided by
  30 ;; the editors of Borland International's compilers for ms-dos.
  31
  32 ;; Currently, s-region-move may be bound only to events that are vectors
  33 ;; of length one and whose last element is a symbol.  Also, the functions
  34 ;; that are given this kind of overlay should be (interactive "p")
  35 ;; functions.
  36
  37 ;; If the following keys are not already bound then...
  38 ;; C-insert is bound to copy-region-as-kill
  39 ;; S-delete is bound to kill-region
  40 ;; S-insert is bound to yank
  41
  42 ;;; Code:
  43
  44 (defvar s-region-overlay (make-overlay 1 1))
  45 (overlay-put s-region-overlay 'face 'region)
  46 (overlay-put s-region-overlay 'priority 1000000) ; for hilit19
  47
  48 (defun s-region-unshift (key)
  49   "Remove shift modifier from last keypress KEY and return that as a key."
  50   (if (vectorp key)
  51       (let ((last (aref key (1- (length key)))))
  52         (if (symbolp last)
  53             (let* ((keyname (symbol-name last))
  54                    (pos (string-match "S-" keyname)))
  55               (if pos
  56                   ;; We skip all initial parts of the event assuming that
  57                   ;; those are setting up the prefix argument to the command.
  58                   (vector (intern (concat (substring keyname 0 pos)
  59                                           (substring keyname (+ 2 pos)))))
  60                 (error "Non-shifted key: %S" key)))
  61           (error "Key does not end in a symbol: %S" key)))
  62     (error "Non-vector key: %S" key)))
  63
  64 (defun s-region-move-p1 (&rest arg)
  65   "This is an overlay function to point-moving keys that are interactive \"p\"."
  66   (interactive "p")
  67   (apply (function s-region-move) arg))
  68
  69 (defun s-region-move-p2 (&rest arg)
  70   "This is an overlay function to point-moving keys that are interactive \"P\"."
  71   (interactive "P")
  72   (apply (function s-region-move) arg))
  73
  74 (defun s-region-move (&rest arg)
  75   (if (if mark-active (not (equal last-command 's-region-move)) t)
  76       (set-mark-command nil)
  77     (message "")) ; delete the "Mark set" message
  78   (setq this-command 's-region-move)
  79   (apply (key-binding (s-region-unshift (this-command-keys))) arg)
  80   (move-overlay s-region-overlay (mark) (point) (current-buffer))
  81   (sit-for 1)
  82   (delete-overlay s-region-overlay))
  83
  84 (defun s-region-bind (keylist &optional map)
  85   "Bind shifted keys in KEYLIST to `s-region-move-p1' or `s-region-move-p2'.
  86 Each key in KEYLIST is shifted and bound to one of the `s-region-move'
  87 functions provided it is already bound to some command or other.
  88 Optional second argument MAP specifies keymap to add binding to, defaulting
  89 to global keymap."
  90   (let ((p2 (list 'scroll-up 'scroll-down
  91                   'beginning-of-buffer 'end-of-buffer)))
  92     (or map (setq map global-map))
  93     (while keylist
  94       (let* ((key (car keylist))
  95              (binding (key-binding key)))
  96         (if (commandp binding)
  97             (define-key
  98               map
  99               (vector (intern (concat "S-" (symbol-name (aref key 0)))))
 100               (cond ((memq binding p2)
 101                      's-region-move-p2)
 102                     (t 's-region-move-p1)))))
 103       (setq keylist (cdr keylist)))))
 104
 105 ;; Single keys (plus modifiers) only!
 106 (s-region-bind
 107  (list [right] [left] [up] [down]
 108        [C-left] [C-right] [C-up] [C-down]
 109        [M-left] [M-right] [M-up] [M-down]
 110        [next] [previous] [home] [end]
 111        [C-next] [C-previous] [C-home] [C-end]
 112        [M-next] [M-previous] [M-home] [M-end]))
 113
 114 (or (global-key-binding [C-insert])
 115     (global-set-key [C-insert] 'copy-region-as-kill))
 116 (or (global-key-binding [S-delete])
 117     (global-set-key [S-delete] 'kill-region))
 118 (or (global-key-binding [S-insert])
 119     (global-set-key [S-insert] 'yank))
 120
 121 (provide 's-region)
 122
 123 ;; arch-tag: a471e912-18d7-4247-a29b-2100bca180ff
 124 ;;; s-region.el ends here